Instance

• Implements: com.aliyun.ros.cdk.mongodb.datasource.IInstance

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

Initializers

import com.aliyun.ros.cdk.mongodb.datasource.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

instanceId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceId: The ID of the mongos.

refreshOptions^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.mongodb.datasource.Instance;
Instance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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 java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAccountDescription^Required

public java.lang.Object getAttrAccountDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AccountDescription: The description of the account.

attrAccountName^Required

public java.lang.Object getAttrAccountName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AccountName: The name of the account.

Value: *root * .

attrAutoRenew^Required

public java.lang.Object getAttrAutoRenew();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrAutoRenewDuration();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AutoRenewDuration: Auto Renew Duration.

attrBackupInterval^Required

public java.lang.Object getAttrBackupInterval();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrBackupRetentionPeriod();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute BackupRetentionPeriod: The retention period of the backup data.

Unit: day.

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The Database create time.

attrDbInstanceClass^Required

public java.lang.Object getAttrDbInstanceClass();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DBInstanceClass: The instance type of the instance.

attrDbInstanceDescription^Required

public java.lang.Object getAttrDbInstanceDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DBInstanceDescription: The name of the instance.

attrDbInstanceReleaseProtection^Required

public java.lang.Object getAttrDbInstanceReleaseProtection();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: true false

attrDbInstanceStorage^Required

public java.lang.Object getAttrDbInstanceStorage();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DbInstanceStorage: The storage capacity of the instance.

attrDbInstanceType^Required

public java.lang.Object getAttrDbInstanceType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DBInstanceType: The architecture of the instance.

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

attrEnableBackupLog^Required

public java.lang.Object getAttrEnableBackupLog();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrEngine();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Engine: The database engine of the instance.

Default value: mongodb.

attrEngineVersion^Required

public java.lang.Object getAttrEngineVersion();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrExpireTime();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrHiddenZoneId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the mongos.

attrKindCode^Required

public java.lang.Object getAttrKindCode();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrLastDowngradeTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrLockMode^Required

public java.lang.Object getAttrLockMode();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrLogBackupRetentionPeriod();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: 7 to 730.

attrMaintainEndTime^Required

public java.lang.Object getAttrMaintainEndTime();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrMaintainStartTime();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrMongosList();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MongosList: The information of the mongos nodes.

attrNetworkAddresses^Required

public java.lang.Object getAttrNetworkAddresses();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NetworkAddresses: The endpoints of ApsaraDB for MongoDB instances.

attrNetworkType^Required

public java.lang.Object getAttrNetworkType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NetworkType: The network type of the instance.

Valid values: Classic: classic network VPC: VPC

attrParameters^Required

public java.lang.Object getAttrParameters();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrPaymentType^Required

public java.lang.Object getAttrPaymentType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: The billing method of the Database.

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

attrPreferredBackupPeriod^Required

public java.lang.Object getAttrPreferredBackupPeriod();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrPreferredBackupTime();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrProtocolType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ProtocolType: The access protocol type of the instance.

Valid values: mongodb dynamodb

attrReadonlyReplicas^Required

public java.lang.Object getAttrReadonlyReplicas();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrReplicaSetsConnections();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReplicaSetsConnections: ReplicaSets Connections.

attrReplicationFactor^Required

public java.lang.Object getAttrReplicationFactor();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReplicationFactor: The number of nodes in the instance.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrSecondaryZoneId^Required

public java.lang.Object getAttrSecondaryZoneId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrSecurityGroupId^Required

public java.lang.Object getAttrSecurityGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityGroupId: The ID of the ECS security group.

attrSecurityIpList^Required

public java.lang.Object getAttrSecurityIpList();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityIpList: The name of the IP whitelist.

attrSecurityIps^Required

public java.lang.Object getAttrSecurityIps();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityIps: The IP addresses in the default whitelist.

attrShardList^Required

public java.lang.Object getAttrShardList();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ShardList: The information of the shard nodes.

attrSnapshotBackupType^Required

public java.lang.Object getAttrSnapshotBackupType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SnapshotBackupType: The snapshot backup type.

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

attrSslExpiredTime^Required

public java.lang.Object getAttrSslExpiredTime();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrSslStatus();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrStorageEngine();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute StorageEngine: The Storage Engine Of The Instance Type.

attrTags^Required

public java.lang.Object getAttrTags();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The details of the instance tags.

attrTdeStatus^Required

public java.lang.Object getAttrTdeStatus();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TdeStatus: The TDE status.

Valid values: enabled disabled

attrVpcAuthMode^Required

public java.lang.Object getAttrVpcAuthMode();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrVpcId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcId: The VPC ID of the instance.

attrVSwitchId^Required

public java.lang.Object getAttrVSwitchId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: The vSwitch ID of the instance.

attrZoneId^Required

public java.lang.Object getAttrZoneId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public InstanceProps getProps();

• Type: InstanceProps