Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::MONGODB::Instance, which is used to create or clone an ApsaraDB for MongoDB replica set instance.

Initializers 

import com.aliyun.ros.cdk.mongodb.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbInstanceClass(java.lang.String)
    .dbInstanceClass(IResolvable)
    .dbInstanceStorage(java.lang.Number)
    .dbInstanceStorage(IResolvable)
//  .accountPassword(java.lang.String)
//  .accountPassword(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .backupId(java.lang.String)
//  .backupId(IResolvable)
//  .businessInfo(java.lang.String)
//  .businessInfo(IResolvable)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .couponNo(java.lang.String)
//  .couponNo(IResolvable)
//  .databaseNames(java.lang.String)
//  .databaseNames(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .engineVersion(java.lang.String)
//  .engineVersion(IResolvable)
//  .hiddenZoneId(java.lang.String)
//  .hiddenZoneId(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .privateConnections(IResolvable)
//  .privateConnections(PrivateConnectionsProperty)
//  .readonlyReplicas(java.lang.Number)
//  .readonlyReplicas(IResolvable)
//  .replicationFactor(java.lang.Number)
//  .replicationFactor(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .restoreTime(java.lang.String)
//  .restoreTime(IResolvable)
//  .secondaryZoneId(java.lang.String)
//  .secondaryZoneId(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .securityIpArray(java.lang.String)
//  .securityIpArray(IResolvable)
//  .srcDbInstanceId(java.lang.String)
//  .srcDbInstanceId(IResolvable)
//  .storageEngine(java.lang.String)
//  .storageEngine(IResolvable)
//  .storageType(java.lang.String)
//  .storageType(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .tdeStatus(java.lang.Boolean)
//  .tdeStatus(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vpcPasswordFree(java.lang.Boolean)
//  .vpcPasswordFree(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
dbInstanceClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceClass: MongoDB instance supported instance type, make sure it should be correct.
dbInstanceStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceStorage: Database instance storage size.
accountPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountPassword: Root account password, can contain the letters, numbers or underscores the composition, length of 6~32 bit.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Indicates whether automatic renewal is enabled for the instance.
backupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property backupId: Specific backup set Id.
businessInfo java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property businessInfo: The business information.
chargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property chargeType: The billing method of the instance.values:PostPaid: Pay-As-You-Go.PrePaid: Subscription.Default value: PostPaid.
couponNo java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property couponNo: The coupon code.
databaseNames java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property databaseNames: The name of the database.
dbInstanceDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceDescription: Description of created database instance.
engineVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property engineVersion: Database instance version.
hiddenZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hiddenZoneId: Configure the zone where the hidden node resides to implement multi-availability zone deployment.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription period of the instance.Default Unit: Month.Valid values: [1~9], 12, 24, 36. Default to 1.
privateConnections com.aliyun.ros.cdk.core.IResolvable OR PrivateConnectionsProperty Property privateConnections: Connection configs of private connection.
readonlyReplicas java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property readonlyReplicas: Number of read-only nodes, in the range of 1-5.
replicationFactor java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property replicationFactor: The number of nodes in the replica set.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
restoreTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property restoreTime: The time to restore the cloned instance to.
secondaryZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secondaryZoneId: Configure the zone where the secondary node resides to implement multi-availability zone deployment.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityGroupId: The ID of the ECS security group.
securityIpArray java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityIpArray: Security ips to add or remove.
srcDbInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property srcDbInstanceId: Create an instance of the backup set based on an instance.
storageEngine java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storageEngine: Database storage engine.Support WiredTiger, RocksDB, TerarkDB.
storageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storageType: The storage type of the instance.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
tdeStatus java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The VPC id to create mongodb instance.
vpcPasswordFree java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The vSwitch Id to create mongodb instance.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: On which zone to create the instance.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dbInstanceClassRequired

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

Property dbInstanceClass: MongoDB instance supported instance type, make sure it should be correct.

dbInstanceStorageRequired

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

Property dbInstanceStorage: Database instance storage size.

MongoDB is [5,3000], increased every 10 GB, Unit in GB

accountPasswordOptional

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

Property accountPassword: Root account password, can contain the letters, numbers or underscores the composition, length of 6~32 bit.

autoRenewOptional

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

Property autoRenew: Indicates whether automatic renewal is enabled for the instance.

Valid values:true: Automatic renewal is enabled.false: Automatic renewal is not enabled. You must renew the instance manually.Default value: false.

backupIdOptional

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

Property backupId: Specific backup set Id.

businessInfoOptional

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

Property businessInfo: The business information.

It is an additional parameter.

chargeTypeOptional

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

Property chargeType: The billing method of the instance.values:PostPaid: Pay-As-You-Go.PrePaid: Subscription.Default value: PostPaid.

couponNoOptional

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

Property couponNo: The coupon code.

Default value:youhuiquan_promotion_option_id_for_blank.

databaseNamesOptional

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

Property databaseNames: The name of the database.

dbInstanceDescriptionOptional

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

Property dbInstanceDescription: Description of created database instance.

engineVersionOptional

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

Property engineVersion: Database instance version.

hiddenZoneIdOptional

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

Property hiddenZoneId: Configure the zone where the hidden node resides to implement multi-availability zone deployment.

When the value of the EngineVersion is 4.4 and later, this parameter is available and required. The value of this parameter cannot be the same as that of ZoneId and SecondaryZoneId.

periodOptional

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

Property period: The subscription period of the instance.Default Unit: Month.Valid values: [1~9], 12, 24, 36. Default to 1.

privateConnectionsOptional

Property privateConnections: Connection configs of private connection.

readonlyReplicasOptional

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

Property readonlyReplicas: Number of read-only nodes, in the range of 1-5.

replicationFactorOptional

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

Property replicationFactor: The number of nodes in the replica set.

Allowed values: [3, 5, 7], default to 3.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group.

restoreTimeOptional

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

Property restoreTime: The time to restore the cloned instance to.

The format is yyyy-MM-ddTHH:mm:ssZ.This parameter can only be specified when this operation is called to clone instances.You must also specify theSrcDBInstanceIdparameter and theBackupIdparameter.You can clone instances to any restore time in the past seven days.

secondaryZoneIdOptional

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

Property secondaryZoneId: Configure the zone where the secondary node resides to implement multi-availability zone deployment.

When the value of the EngineVersion is 4.4 and later, this parameter is available and required.The value of this parameter cannot be the same as that of ZoneId and HiddenZoneId.

securityGroupIdOptional

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

Property securityGroupId: The ID of the ECS security group.

Each ApsaraDB for MongoDB instance can be added in up to 10 security group. You can call the ECS DescribeSecurityGroup to describe the ID of the security group in the target region.

securityIpArrayOptional

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

Property securityIpArray: Security ips to add or remove.

srcDbInstanceIdOptional

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

Property srcDbInstanceId: Create an instance of the backup set based on an instance.

storageEngineOptional

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

Property storageEngine: Database storage engine.Support WiredTiger, RocksDB, TerarkDB.

storageTypeOptional

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

Property storageType: The storage type of the instance.

Instances of MongoDB 4.4 and later only support cloud disks. cloud_essd1 is selected if you leave this parameter empty. Instances of MongoDB 4.2 and earlier support only local disks. local_ssd is selected if you leave this parameter empty.

tagsOptional

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

tdeStatusOptional

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

Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).

Valid values: true: enable TDE false: disable TDE (default) Note: You cannot disable TDE after it is enabled.

vpcIdOptional

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

Property vpcId: The VPC id to create mongodb instance.

vpcPasswordFreeOptional

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

Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.

If set to:

  • true: enables password free.
  • false: disables password free.

vSwitchIdOptional

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

Property vSwitchId: The vSwitch Id to create mongodb instance.

zoneIdOptional

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

Property zoneId: On which zone to create the instance.

If VpcId and VSwitchId is specified, ZoneId is required and VSwitch should be in same zone.

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 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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrConnectionUri com.aliyun.ros.cdk.core.IResolvable Attribute ConnectionURI: Connection uri.
attrDbInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute DBInstanceId: The instance id of created mongodb instance.
attrDbInstanceStatus com.aliyun.ros.cdk.core.IResolvable Attribute DBInstanceStatus: Status of mongodb instance.
attrOrderId com.aliyun.ros.cdk.core.IResolvable Attribute OrderId: Order Id of created instance.
attrReplicaSetName com.aliyun.ros.cdk.core.IResolvable Attribute ReplicaSetName: Name of replica set.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrConnectionUriRequired 

public IResolvable getAttrConnectionUri();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionURI: Connection uri.

attrDbInstanceIdRequired 

public IResolvable getAttrDbInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBInstanceId: The instance id of created mongodb instance.

attrDbInstanceStatusRequired 

public IResolvable getAttrDbInstanceStatus();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBInstanceStatus: Status of mongodb instance.

attrOrderIdRequired 

public IResolvable getAttrOrderId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: Order Id of created instance.

attrReplicaSetNameRequired 

public IResolvable getAttrReplicaSetName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ReplicaSetName: Name of replica set.