Instance

• Implements: @alicloud/ros-cdk-mongodb.datasource.IInstance

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)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: InstanceProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrAccountDescription^Required

public readonly attrAccountDescription: string | IResolvable;

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

Attribute AccountDescription: The description of the account.

attrAccountName^Required

public readonly attrAccountName: string | IResolvable;

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

Attribute AccountName: The name of the account.

Value: *root * .

attrAutoRenew^Required

public readonly attrAutoRenew: string | IResolvable;

• Type: string | @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.

attrAutoRenewDuration^Required

public readonly attrAutoRenewDuration: string | IResolvable;

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

Attribute AutoRenewDuration: Auto Renew Duration.

attrBackupInterval^Required

public readonly attrBackupInterval: string | IResolvable;

• Type: string | @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.

attrBackupRetentionPeriod^Required

public readonly attrBackupRetentionPeriod: string | IResolvable;

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

Attribute BackupRetentionPeriod: The retention period of the backup data.

Unit: day.

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

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

Attribute CreateTime: The Database create time.

attrDbInstanceClass^Required

public readonly attrDbInstanceClass: string | IResolvable;

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

Attribute DBInstanceClass: The instance type of the instance.

attrDbInstanceDescription^Required

public readonly attrDbInstanceDescription: string | IResolvable;

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

Attribute DBInstanceDescription: The name of the instance.

attrDbInstanceReleaseProtection^Required

public readonly attrDbInstanceReleaseProtection: string | IResolvable;

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

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

Valid values: true false

attrDbInstanceStorage^Required

public readonly attrDbInstanceStorage: string | IResolvable;

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

Attribute DbInstanceStorage: The storage capacity of the instance.

attrDbInstanceType^Required

public readonly attrDbInstanceType: string | IResolvable;

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

Attribute DBInstanceType: The architecture of the instance.

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

attrEnableBackupLog^Required

public readonly attrEnableBackupLog: string | IResolvable;

• Type: string | @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.

attrEngine^Required

public readonly attrEngine: string | IResolvable;

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

Attribute Engine: The database engine of the instance.

Default value: mongodb.

attrEngineVersion^Required

public readonly attrEngineVersion: string | IResolvable;

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

Attribute EngineVersion: The database engine version of the instance.

6.0 5.0 4.4 4.2 4.0

attrExpireTime^Required

public readonly attrExpireTime: string | IResolvable;

• Type: string | @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.

attrHiddenZoneId^Required

public readonly attrHiddenZoneId: string | IResolvable;

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

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

attrInstanceId^Required

public readonly attrInstanceId: string | IResolvable;

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

Attribute InstanceId: The ID of the mongos.

attrKindCode^Required

public readonly attrKindCode: string | IResolvable;

• Type: string | @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

attrLastDowngradeTime^Required

public readonly attrLastDowngradeTime: string | IResolvable;

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

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

attrLockMode^Required

public readonly attrLockMode: string | IResolvable;

• Type: string | @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.

attrLogBackupRetentionPeriod^Required

public readonly attrLogBackupRetentionPeriod: string | IResolvable;

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

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

Valid values: 7 to 730.

attrMaintainEndTime^Required

public readonly attrMaintainEndTime: string | IResolvable;

• Type: string | @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.

attrMaintainStartTime^Required

public readonly attrMaintainStartTime: string | IResolvable;

• Type: string | @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.

attrMongosList^Required

public readonly attrMongosList: string | IResolvable;

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

Attribute MongosList: The information of the mongos nodes.

attrNetworkAddresses^Required

public readonly attrNetworkAddresses: string | IResolvable;

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

Attribute NetworkAddresses: The endpoints of ApsaraDB for MongoDB instances.

attrNetworkType^Required

public readonly attrNetworkType: string | IResolvable;

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

Attribute NetworkType: The network type of the instance.

Valid values: Classic: classic network VPC: VPC

attrParameters^Required

public readonly attrParameters: string | IResolvable;

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

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

attrPaymentType^Required

public readonly attrPaymentType: string | IResolvable;

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

Attribute PaymentType: The billing method of the Database.

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

attrPreferredBackupPeriod^Required

public readonly attrPreferredBackupPeriod: string | IResolvable;

• Type: string | @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

attrPreferredBackupTime^Required

public readonly attrPreferredBackupTime: string | IResolvable;

• Type: string | @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.

attrProtocolType^Required

public readonly attrProtocolType: string | IResolvable;

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

Attribute ProtocolType: The access protocol type of the instance.

Valid values: mongodb dynamodb

attrReadonlyReplicas^Required

public readonly attrReadonlyReplicas: string | IResolvable;

• Type: string | @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.

attrReplicaSetsConnections^Required

public readonly attrReplicaSetsConnections: string | IResolvable;

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

Attribute ReplicaSetsConnections: ReplicaSets Connections.

attrReplicationFactor^Required

public readonly attrReplicationFactor: string | IResolvable;

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

Attribute ReplicationFactor: The number of nodes in the instance.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

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

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

attrSecondaryZoneId^Required

public readonly attrSecondaryZoneId: string | IResolvable;

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

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

attrSecurityGroupId^Required

public readonly attrSecurityGroupId: string | IResolvable;

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

Attribute SecurityGroupId: The ID of the ECS security group.

attrSecurityIpList^Required

public readonly attrSecurityIpList: string | IResolvable;

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

Attribute SecurityIpList: The name of the IP whitelist.

attrSecurityIps^Required

public readonly attrSecurityIps: string | IResolvable;

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

Attribute SecurityIps: The IP addresses in the default whitelist.

attrShardList^Required

public readonly attrShardList: string | IResolvable;

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

Attribute ShardList: The information of the shard nodes.

attrSnapshotBackupType^Required

public readonly attrSnapshotBackupType: string | IResolvable;

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

Attribute SnapshotBackupType: The snapshot backup type.

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

attrSslExpiredTime^Required

public readonly attrSslExpiredTime: string | IResolvable;

• Type: string | @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).

attrSslStatus^Required

public readonly attrSslStatus: string | IResolvable;

• Type: string | @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.

attrStorageEngine^Required

public readonly attrStorageEngine: string | IResolvable;

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

Attribute StorageEngine: The Storage Engine Of The Instance Type.

attrTags^Required

public readonly attrTags: string | IResolvable;

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

Attribute Tags: The details of the instance tags.

attrTdeStatus^Required

public readonly attrTdeStatus: string | IResolvable;

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

Attribute TdeStatus: The TDE status.

Valid values: enabled disabled

attrVpcAuthMode^Required

public readonly attrVpcAuthMode: string | IResolvable;

• Type: string | @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.

attrVpcId^Required

public readonly attrVpcId: string | IResolvable;

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

Attribute VpcId: The VPC ID of the instance.

attrVSwitchId^Required

public readonly attrVSwitchId: string | IResolvable;

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

Attribute VSwitchId: The vSwitch ID of the instance.

attrZoneId^Required

public readonly attrZoneId: string | IResolvable;

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

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

props^Required

public readonly props: InstanceProps;

• Type: InstanceProps