IInstance
-
Extends: AlibabaCloud.SDK.ROS.CDK.Core.IResource
-
Implemented By: AlibabaCloud.SDK.ROS.CDK.Mongodb.datasource.Instance, AlibabaCloud.SDK.ROS.CDK.Mongodb.datasource.IInstance
Represents a Instance.
Properties
| Name | Type | Description |
|---|---|---|
Node | AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode | The construct tree node for this construct. |
Env | AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment | The environment this resource belongs to. |
Stack | AlibabaCloud.SDK.ROS.CDK.Core.Stack | The stack in which this resource is defined. |
AttrAccountDescription | object | Attribute AccountDescription: The description of the account. |
AttrAccountName | object | Attribute AccountName: The name of the account. |
AttrAutoRenew | object | Attribute AutoRenew: Indicates whether auto-renewal is enabled for the instance. |
AttrAutoRenewDuration | object | Attribute AutoRenewDuration: Auto Renew Duration. |
AttrBackupInterval | object | Attribute BackupInterval: The frequency at which high-frequency backup is created. |
AttrBackupRetentionPeriod | object | Attribute BackupRetentionPeriod: The retention period of the backup data. |
AttrCreateTime | object | Attribute CreateTime: The Database create time. |
AttrDbInstanceClass | object | Attribute DBInstanceClass: The instance type of the instance. |
AttrDbInstanceDescription | object | Attribute DBInstanceDescription: The name of the instance. |
AttrDbInstanceReleaseProtection | object | Attribute DBInstanceReleaseProtection: Indicates whether release protection is enabled for the instance. |
AttrDbInstanceStorage | object | Attribute DbInstanceStorage: The storage capacity of the instance. |
AttrDbInstanceType | object | Attribute DBInstanceType: The architecture of the instance. |
AttrEnableBackupLog | object | Attribute EnableBackupLog: Indicates whether the log backup feature is enabled. |
AttrEngine | object | Attribute Engine: The database engine of the instance. |
AttrEngineVersion | object | Attribute EngineVersion: The database engine version of the instance. |
AttrExpireTime | object | Attribute ExpireTime: The time when the subscription instance expires. |
AttrHiddenZoneId | object | Attribute HiddenZoneId: The zone where the hidden node resides for multi-zone deployment. |
AttrInstanceId | object | Attribute InstanceId: The ID of the mongos. |
AttrKindCode | object | Attribute KindCode: The kind code of the instance. |
AttrLastDowngradeTime | object | Attribute LastDowngradeTime: The date when the last downgrade operation was performed on the instance. |
AttrLockMode | object | Attribute LockMode: The lock status of the instance. |
AttrLogBackupRetentionPeriod | object | Attribute LogBackupRetentionPeriod: The number of days for which log backups are retained. |
AttrMaintainEndTime | object | Attribute MaintainEndTime: The end time of the maintenance window. |
AttrMaintainStartTime | object | Attribute MaintainStartTime: The start time of the maintenance window. |
AttrMongosList | object | Attribute MongosList: The information of the mongos nodes. |
AttrNetworkAddresses | object | Attribute NetworkAddresses: The endpoints of ApsaraDB for MongoDB instances. |
AttrNetworkType | object | Attribute NetworkType: The network type of the instance. |
AttrParameters | object | Attribute Parameters: The settings of the parameters that have taken effect. |
AttrPaymentType | object | Attribute PaymentType: The billing method of the Database. |
AttrPreferredBackupPeriod | object | Attribute PreferredBackupPeriod: The day of a week on which to back up data. |
AttrPreferredBackupTime | object | Attribute PreferredBackupTime: The time range during which the backup was created. |
AttrProtocolType | object | Attribute ProtocolType: The access protocol type of the instance. |
AttrReadonlyReplicas | object | Attribute ReadonlyReplicas: The number of read-only nodes in the shard node. |
AttrReplicaSetsConnections | object | Attribute ReplicaSetsConnections: ReplicaSets Connections. |
AttrReplicationFactor | object | Attribute ReplicationFactor: The number of nodes in the instance. |
AttrResourceGroupId | object | Attribute ResourceGroupId: The ID of the resource group to which the instance belongs. |
AttrSecondaryZoneId | object | Attribute SecondaryZoneId: The zone where the secondary node resides for multi-zone deployment. |
AttrSecurityGroupId | object | Attribute SecurityGroupId: The ID of the ECS security group. |
AttrSecurityIpList | object | Attribute SecurityIpList: The name of the IP whitelist. |
AttrSecurityIps | object | Attribute SecurityIps: The IP addresses in the default whitelist. |
AttrShardList | object | Attribute ShardList: The information of the shard nodes. |
AttrSnapshotBackupType | object | Attribute SnapshotBackupType: The snapshot backup type. |
AttrSslExpiredTime | object | Attribute SslExpiredTime: The time when the SSL certificate expires. |
AttrSslStatus | object | Attribute SslStatus: The status of the SSL feature. |
AttrStorageEngine | object | Attribute StorageEngine: The Storage Engine Of The Instance Type. |
AttrTags | object | Attribute Tags: The details of the instance tags. |
AttrTdeStatus | object | Attribute TdeStatus: The TDE status. |
AttrVpcAuthMode | object | Attribute VpcAuthMode: Indicates whether password-free access within the VPC is enabled. |
AttrVpcId | object | Attribute VpcId: The VPC ID of the instance. |
AttrVSwitchId | object | Attribute VSwitchId: The vSwitch ID of the instance. |
AttrZoneId | object | Attribute ZoneId: The ID of the zone in which the instance resides. |
Props | InstanceProps | No description. |
NodeRequired
public ConstructNode Node { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode
The construct tree node for this construct.
EnvRequired
public IResourceEnvironment Env { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
StackRequired
public Stack Stack { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack
The stack in which this resource is defined.
AttrAccountDescriptionRequired
public object AttrAccountDescription { get; }
- Type: object
Attribute AccountDescription: The description of the account.
AttrAccountNameRequired
public object AttrAccountName { get; }
- Type: object
Attribute AccountName: The name of the account.
Value: *root * .
AttrAutoRenewRequired
public object AttrAutoRenew { get; }
- Type: object
Attribute AutoRenew: Indicates whether auto-renewal is enabled for the instance.
Valid values: true: Auto-renewal is enabled for the instance. false: Auto-renewal is disabled for the instance.
AttrAutoRenewDurationRequired
public object AttrAutoRenewDuration { get; }
- Type: object
Attribute AutoRenewDuration: Auto Renew Duration.
AttrBackupIntervalRequired
public object AttrBackupInterval { get; }
- Type: object
Attribute BackupInterval: The frequency at which high-frequency backup is created.
Valid values: -1: High-frequency backup is disabled. 15: every 15 minutes. 30: every 30 minutes. 60: every hour. 120: every 2 hours. 180: every 3 hours. 240: every 4 hours. 360: every 6 hours. 480: every 8 hours. 720: every 12 hours.
AttrBackupRetentionPeriodRequired
public object AttrBackupRetentionPeriod { get; }
- Type: object
Attribute BackupRetentionPeriod: The retention period of the backup data.
Unit: day.
AttrCreateTimeRequired
public object AttrCreateTime { get; }
- Type: object
Attribute CreateTime: The Database create time.
AttrDbInstanceClassRequired
public object AttrDbInstanceClass { get; }
- Type: object
Attribute DBInstanceClass: The instance type of the instance.
AttrDbInstanceDescriptionRequired
public object AttrDbInstanceDescription { get; }
- Type: object
Attribute DBInstanceDescription: The name of the instance.
AttrDbInstanceReleaseProtectionRequired
public object AttrDbInstanceReleaseProtection { get; }
- Type: object
Attribute DBInstanceReleaseProtection: Indicates whether release protection is enabled for the instance.
Valid values: true false
AttrDbInstanceStorageRequired
public object AttrDbInstanceStorage { get; }
- Type: object
Attribute DbInstanceStorage: The storage capacity of the instance.
AttrDbInstanceTypeRequired
public object AttrDbInstanceType { get; }
- Type: object
Attribute DBInstanceType: The architecture of the instance.
Valid values: replicate: replica set instance sharding: sharded cluster instance
AttrEnableBackupLogRequired
public object AttrEnableBackupLog { get; }
- Type: object
Attribute EnableBackupLog: Indicates whether the log backup feature is enabled.
Valid values: 0 (default): The log backup feature is disabled. 1: The log backup feature is enabled.
AttrEngineRequired
public object AttrEngine { get; }
- Type: object
Attribute Engine: The database engine of the instance.
Default value: mongodb.
AttrEngineVersionRequired
public object AttrEngineVersion { get; }
- Type: object
Attribute EngineVersion: The database engine version of the instance.
6.0 5.0 4.4 4.2 4.0
AttrExpireTimeRequired
public object AttrExpireTime { get; }
- Type: object
Attribute ExpireTime: The time when the subscription instance expires.
The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.
AttrHiddenZoneIdRequired
public object AttrHiddenZoneId { get; }
- Type: object
Attribute HiddenZoneId: The zone where the hidden node resides for multi-zone deployment.
AttrInstanceIdRequired
public object AttrInstanceId { get; }
- Type: object
Attribute InstanceId: The ID of the mongos.
AttrKindCodeRequired
public object AttrKindCode { get; }
- Type: object
Attribute KindCode: The kind code of the instance.
Valid values: 0: physical machine 1: Elastic Compute Service (ECS) instance 2: Docker cluster 18: Kubernetes cluster
AttrLastDowngradeTimeRequired
public object AttrLastDowngradeTime { get; }
- Type: object
Attribute LastDowngradeTime: The date when the last downgrade operation was performed on the instance.
AttrLockModeRequired
public object AttrLockMode { get; }
- Type: object
Attribute LockMode: The lock status of the instance.
Valid values: Unlock: The instance is not locked. ManualLock: The instance is manually locked. LockByExpiration: The instance is automatically locked due to instance expiration. LockByRestoration: The instance is automatically locked before the instance is rolled back. LockByDiskQuota: The instance is automatically locked after the storage space is exhausted. Released: The instance is released.
AttrLogBackupRetentionPeriodRequired
public object AttrLogBackupRetentionPeriod { get; }
- Type: object
Attribute LogBackupRetentionPeriod: The number of days for which log backups are retained.
Valid values: 7 to 730.
AttrMaintainEndTimeRequired
public object AttrMaintainEndTime { get; }
- Type: object
Attribute MaintainEndTime: The end time of the maintenance window.
The time follows the ISO 8601 standard in the HH:mmZ format. The time is displayed in UTC.
AttrMaintainStartTimeRequired
public object AttrMaintainStartTime { get; }
- Type: object
Attribute MaintainStartTime: The start time of the maintenance window.
The time follows the ISO 8601 standard in the HH:mmZ format. The time is displayed in UTC.
AttrMongosListRequired
public object AttrMongosList { get; }
- Type: object
Attribute MongosList: The information of the mongos nodes.
AttrNetworkAddressesRequired
public object AttrNetworkAddresses { get; }
- Type: object
Attribute NetworkAddresses: The endpoints of ApsaraDB for MongoDB instances.
AttrNetworkTypeRequired
public object AttrNetworkType { get; }
- Type: object
Attribute NetworkType: The network type of the instance.
Valid values: Classic: classic network VPC: VPC
AttrParametersRequired
public object AttrParameters { get; }
- Type: object
Attribute Parameters: The settings of the parameters that have taken effect.
AttrPaymentTypeRequired
public object AttrPaymentType { get; }
- Type: object
Attribute PaymentType: The billing method of the Database.
Valid values: PrePaid: subscription PostPaid: pay-as-you-go.
AttrPreferredBackupPeriodRequired
public object AttrPreferredBackupPeriod { get; }
- Type: object
Attribute PreferredBackupPeriod: The day of a week on which to back up data.
Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday
AttrPreferredBackupTimeRequired
public object AttrPreferredBackupTime { get; }
- Type: object
Attribute PreferredBackupTime: The time range during which the backup was created.
The time follows the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.
AttrProtocolTypeRequired
public object AttrProtocolType { get; }
- Type: object
Attribute ProtocolType: The access protocol type of the instance.
Valid values: mongodb dynamodb
AttrReadonlyReplicasRequired
public object AttrReadonlyReplicas { get; }
- Type: object
Attribute ReadonlyReplicas: The number of read-only nodes in the shard node.
Valid values: 0 to 5. The value must be an integer.
AttrReplicaSetsConnectionsRequired
public object AttrReplicaSetsConnections { get; }
- Type: object
Attribute ReplicaSetsConnections: ReplicaSets Connections.
AttrReplicationFactorRequired
public object AttrReplicationFactor { get; }
- Type: object
Attribute ReplicationFactor: The number of nodes in the instance.
AttrResourceGroupIdRequired
public object AttrResourceGroupId { get; }
- Type: object
Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
AttrSecondaryZoneIdRequired
public object AttrSecondaryZoneId { get; }
- Type: object
Attribute SecondaryZoneId: The zone where the secondary node resides for multi-zone deployment.
AttrSecurityGroupIdRequired
public object AttrSecurityGroupId { get; }
- Type: object
Attribute SecurityGroupId: The ID of the ECS security group.
AttrSecurityIpListRequired
public object AttrSecurityIpList { get; }
- Type: object
Attribute SecurityIpList: The name of the IP whitelist.
AttrSecurityIpsRequired
public object AttrSecurityIps { get; }
- Type: object
Attribute SecurityIps: The IP addresses in the default whitelist.
AttrShardListRequired
public object AttrShardList { get; }
- Type: object
Attribute ShardList: The information of the shard nodes.
AttrSnapshotBackupTypeRequired
public object AttrSnapshotBackupType { get; }
- Type: object
Attribute SnapshotBackupType: The snapshot backup type.
Valid values: Flash: single-digit second backup Standard (default): standard backup
AttrSslExpiredTimeRequired
public object AttrSslExpiredTime { get; }
- Type: object
Attribute SslExpiredTime: The time when the SSL certificate expires.
The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).
AttrSslStatusRequired
public object AttrSslStatus { get; }
- Type: object
Attribute SslStatus: The status of the SSL feature.
Valid values: Open: The SSL feature is enabled. Closed: The SSL feature is disabled.
AttrStorageEngineRequired
public object AttrStorageEngine { get; }
- Type: object
Attribute StorageEngine: The Storage Engine Of The Instance Type.
AttrTagsRequired
public object AttrTags { get; }
- Type: object
Attribute Tags: The details of the instance tags.
AttrTdeStatusRequired
public object AttrTdeStatus { get; }
- Type: object
Attribute TdeStatus: The TDE status.
Valid values: enabled disabled
AttrVpcAuthModeRequired
public object AttrVpcAuthMode { get; }
- Type: object
Attribute VpcAuthMode: Indicates whether password-free access within the VPC is enabled.
Valid values: Open: Password-free access within the VPC is enabled. Close: Password-free access within the VPC is disabled, and you must use a password for access. NotSupport: Password-free access within the VPC is not supported.
AttrVpcIdRequired
public object AttrVpcId { get; }
- Type: object
Attribute VpcId: The VPC ID of the instance.
AttrVSwitchIdRequired
public object AttrVSwitchId { get; }
- Type: object
Attribute VSwitchId: The vSwitch ID of the instance.
AttrZoneIdRequired
public object AttrZoneId { get; }
- Type: object
Attribute ZoneId: The ID of the zone in which the instance resides.
PropsRequired
public InstanceProps Props { get; }
- Type: InstanceProps