Skip to content

Instance

This class encapsulates and extends the ROS resource type DATASOURCE::MONGODB::Instance.

Initializers 

import { datasource } from '@alicloud/ros-cdk-mongodb'
new datasource.Instance(scope: Construct, id: string, props: InstanceProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props InstanceProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import { datasource } from '@alicloud/ros-cdk-mongodb'
datasource.Instance.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrAccountDescription @alicloud/ros-cdk-core.IResolvable Attribute AccountDescription: The description of the account.
attrAccountName @alicloud/ros-cdk-core.IResolvable Attribute AccountName: The name of the account.
attrAutoRenew @alicloud/ros-cdk-core.IResolvable Attribute AutoRenew: Indicates whether auto-renewal is enabled for the instance.
attrAutoRenewDuration @alicloud/ros-cdk-core.IResolvable Attribute AutoRenewDuration: Auto Renew Duration.
attrBackupInterval @alicloud/ros-cdk-core.IResolvable Attribute BackupInterval: The frequency at which high-frequency backup is created.
attrBackupRetentionPeriod @alicloud/ros-cdk-core.IResolvable Attribute BackupRetentionPeriod: The retention period of the backup data.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The Database create time.
attrDbInstanceClass @alicloud/ros-cdk-core.IResolvable Attribute DBInstanceClass: The instance type of the instance.
attrDbInstanceDescription @alicloud/ros-cdk-core.IResolvable Attribute DBInstanceDescription: The name of the instance.
attrDbInstanceReleaseProtection @alicloud/ros-cdk-core.IResolvable Attribute DBInstanceReleaseProtection: Indicates whether release protection is enabled for the instance.
attrDbInstanceStorage @alicloud/ros-cdk-core.IResolvable Attribute DbInstanceStorage: The storage capacity of the instance.
attrDbInstanceType @alicloud/ros-cdk-core.IResolvable Attribute DBInstanceType: The architecture of the instance.
attrEnableBackupLog @alicloud/ros-cdk-core.IResolvable Attribute EnableBackupLog: Indicates whether the log backup feature is enabled.
attrEngine @alicloud/ros-cdk-core.IResolvable Attribute Engine: The database engine of the instance.
attrEngineVersion @alicloud/ros-cdk-core.IResolvable Attribute EngineVersion: The database engine version of the instance.
attrExpireTime @alicloud/ros-cdk-core.IResolvable Attribute ExpireTime: The time when the subscription instance expires.
attrHiddenZoneId @alicloud/ros-cdk-core.IResolvable Attribute HiddenZoneId: The zone where the hidden node resides for multi-zone deployment.
attrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: The ID of the mongos.
attrKindCode @alicloud/ros-cdk-core.IResolvable Attribute KindCode: The kind code of the instance.
attrLastDowngradeTime @alicloud/ros-cdk-core.IResolvable Attribute LastDowngradeTime: The date when the last downgrade operation was performed on the instance.
attrLockMode @alicloud/ros-cdk-core.IResolvable Attribute LockMode: The lock status of the instance.
attrLogBackupRetentionPeriod @alicloud/ros-cdk-core.IResolvable Attribute LogBackupRetentionPeriod: The number of days for which log backups are retained.
attrMaintainEndTime @alicloud/ros-cdk-core.IResolvable Attribute MaintainEndTime: The end time of the maintenance window.
attrMaintainStartTime @alicloud/ros-cdk-core.IResolvable Attribute MaintainStartTime: The start time of the maintenance window.
attrMongosList @alicloud/ros-cdk-core.IResolvable Attribute MongosList: The information of the mongos nodes.
attrNetworkAddresses @alicloud/ros-cdk-core.IResolvable Attribute NetworkAddresses: The endpoints of ApsaraDB for MongoDB instances.
attrNetworkType @alicloud/ros-cdk-core.IResolvable Attribute NetworkType: The network type of the instance.
attrParameters @alicloud/ros-cdk-core.IResolvable Attribute Parameters: The settings of the parameters that have taken effect.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The billing method of the Database.
attrPreferredBackupPeriod @alicloud/ros-cdk-core.IResolvable Attribute PreferredBackupPeriod: The day of a week on which to back up data.
attrPreferredBackupTime @alicloud/ros-cdk-core.IResolvable Attribute PreferredBackupTime: The time range during which the backup was created.
attrProtocolType @alicloud/ros-cdk-core.IResolvable Attribute ProtocolType: The access protocol type of the instance.
attrReadonlyReplicas @alicloud/ros-cdk-core.IResolvable Attribute ReadonlyReplicas: The number of read-only nodes in the shard node.
attrReplicaSetsConnections @alicloud/ros-cdk-core.IResolvable Attribute ReplicaSetsConnections: ReplicaSets Connections.
attrReplicationFactor @alicloud/ros-cdk-core.IResolvable Attribute ReplicationFactor: The number of nodes in the instance.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attrSecondaryZoneId @alicloud/ros-cdk-core.IResolvable Attribute SecondaryZoneId: The zone where the secondary node resides for multi-zone deployment.
attrSecurityGroupId @alicloud/ros-cdk-core.IResolvable Attribute SecurityGroupId: The ID of the ECS security group.
attrSecurityIpList @alicloud/ros-cdk-core.IResolvable Attribute SecurityIpList: The name of the IP whitelist.
attrSecurityIps @alicloud/ros-cdk-core.IResolvable Attribute SecurityIps: The IP addresses in the default whitelist.
attrShardList @alicloud/ros-cdk-core.IResolvable Attribute ShardList: The information of the shard nodes.
attrSnapshotBackupType @alicloud/ros-cdk-core.IResolvable Attribute SnapshotBackupType: The snapshot backup type.
attrSslExpiredTime @alicloud/ros-cdk-core.IResolvable Attribute SslExpiredTime: The time when the SSL certificate expires.
attrSslStatus @alicloud/ros-cdk-core.IResolvable Attribute SslStatus: The status of the SSL feature.
attrStorageEngine @alicloud/ros-cdk-core.IResolvable Attribute StorageEngine: The Storage Engine Of The Instance Type.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: The details of the instance tags.
attrTdeStatus @alicloud/ros-cdk-core.IResolvable Attribute TdeStatus: The TDE status.
attrVpcAuthMode @alicloud/ros-cdk-core.IResolvable Attribute VpcAuthMode: Indicates whether password-free access within the VPC is enabled.
attrVpcId @alicloud/ros-cdk-core.IResolvable Attribute VpcId: The VPC ID of the instance.
attrVSwitchId @alicloud/ros-cdk-core.IResolvable Attribute VSwitchId: The vSwitch ID of the instance.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: The ID of the zone in which the instance resides.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAccountDescriptionRequired 

public readonly attrAccountDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AccountDescription: The description of the account.

attrAccountNameRequired 

public readonly attrAccountName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AccountName: The name of the account.

Value: *root * .

attrAutoRenewRequired 

public readonly attrAutoRenew: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrAutoRenewDuration: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AutoRenewDuration: Auto Renew Duration.

attrBackupIntervalRequired 

public readonly attrBackupInterval: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrBackupRetentionPeriod: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BackupRetentionPeriod: The retention period of the backup data.

Unit: day.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The Database create time.

attrDbInstanceClassRequired 

public readonly attrDbInstanceClass: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceClass: The instance type of the instance.

attrDbInstanceDescriptionRequired 

public readonly attrDbInstanceDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceDescription: The name of the instance.

attrDbInstanceReleaseProtectionRequired 

public readonly attrDbInstanceReleaseProtection: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceReleaseProtection: Indicates whether release protection is enabled for the instance.

Valid values: true false

attrDbInstanceStorageRequired 

public readonly attrDbInstanceStorage: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbInstanceStorage: The storage capacity of the instance.

attrDbInstanceTypeRequired 

public readonly attrDbInstanceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceType: The architecture of the instance.

Valid values: replicate: replica set instance sharding: sharded cluster instance

attrEnableBackupLogRequired 

public readonly attrEnableBackupLog: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrEngine: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Engine: The database engine of the instance.

Default value: mongodb.

attrEngineVersionRequired 

public readonly attrEngineVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EngineVersion: The database engine version of the instance.

6.0 5.0 4.4 4.2 4.0

attrExpireTimeRequired 

public readonly attrExpireTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrHiddenZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute HiddenZoneId: The zone where the hidden node resides for multi-zone deployment.

attrInstanceIdRequired 

public readonly attrInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: The ID of the mongos.

attrKindCodeRequired 

public readonly attrKindCode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrLastDowngradeTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute LastDowngradeTime: The date when the last downgrade operation was performed on the instance.

attrLockModeRequired 

public readonly attrLockMode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrLogBackupRetentionPeriod: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute LogBackupRetentionPeriod: The number of days for which log backups are retained.

Valid values: 7 to 730.

attrMaintainEndTimeRequired 

public readonly attrMaintainEndTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrMaintainStartTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrMongosList: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MongosList: The information of the mongos nodes.

attrNetworkAddressesRequired 

public readonly attrNetworkAddresses: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NetworkAddresses: The endpoints of ApsaraDB for MongoDB instances.

attrNetworkTypeRequired 

public readonly attrNetworkType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NetworkType: The network type of the instance.

Valid values: Classic: classic network VPC: VPC

attrParametersRequired 

public readonly attrParameters: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Parameters: The settings of the parameters that have taken effect.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The billing method of the Database.

Valid values: PrePaid: subscription PostPaid: pay-as-you-go.

attrPreferredBackupPeriodRequired 

public readonly attrPreferredBackupPeriod: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PreferredBackupPeriod: The day of a week on which to back up data.

Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday

attrPreferredBackupTimeRequired 

public readonly attrPreferredBackupTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrProtocolType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ProtocolType: The access protocol type of the instance.

Valid values: mongodb dynamodb

attrReadonlyReplicasRequired 

public readonly attrReadonlyReplicas: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrReplicaSetsConnections: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ReplicaSetsConnections: ReplicaSets Connections.

attrReplicationFactorRequired 

public readonly attrReplicationFactor: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ReplicationFactor: The number of nodes in the instance.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.

attrSecondaryZoneIdRequired 

public readonly attrSecondaryZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecondaryZoneId: The zone where the secondary node resides for multi-zone deployment.

attrSecurityGroupIdRequired 

public readonly attrSecurityGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecurityGroupId: The ID of the ECS security group.

attrSecurityIpListRequired 

public readonly attrSecurityIpList: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecurityIpList: The name of the IP whitelist.

attrSecurityIpsRequired 

public readonly attrSecurityIps: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecurityIps: The IP addresses in the default whitelist.

attrShardListRequired 

public readonly attrShardList: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ShardList: The information of the shard nodes.

attrSnapshotBackupTypeRequired 

public readonly attrSnapshotBackupType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SnapshotBackupType: The snapshot backup type.

Valid values: Flash: single-digit second backup Standard (default): standard backup

attrSslExpiredTimeRequired 

public readonly attrSslExpiredTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrSslStatus: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SslStatus: The status of the SSL feature.

Valid values: Open: The SSL feature is enabled. Closed: The SSL feature is disabled.

attrStorageEngineRequired 

public readonly attrStorageEngine: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StorageEngine: The Storage Engine Of The Instance Type.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The details of the instance tags.

attrTdeStatusRequired 

public readonly attrTdeStatus: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute TdeStatus: The TDE status.

Valid values: enabled disabled

attrVpcAuthModeRequired 

public readonly attrVpcAuthMode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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 readonly attrVpcId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcId: The VPC ID of the instance.

attrVSwitchIdRequired 

public readonly attrVSwitchId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VSwitchId: The vSwitch ID of the instance.

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ZoneId: The ID of the zone in which the instance resides.