Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::MONGODB::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)
//  .auditPolicyOptions(IResolvable)
//  .auditPolicyOptions(AuditPolicyOptionsProperty)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .backupId(java.lang.String)
//  .backupId(IResolvable)
//  .backupPolicyOptions(IResolvable)
//  .backupPolicyOptions(BackupPolicyOptionsProperty)
//  .businessInfo(java.lang.String)
//  .businessInfo(IResolvable)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .clusterId(java.lang.String)
//  .clusterId(IResolvable)
//  .couponNo(java.lang.String)
//  .couponNo(IResolvable)
//  .databaseNames(java.lang.String)
//  .databaseNames(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .dbInstanceReleaseProtection(java.lang.Boolean)
//  .dbInstanceReleaseProtection(IResolvable)
//  .encrypted(java.lang.Boolean)
//  .encrypted(IResolvable)
//  .encryptionKey(java.lang.String)
//  .encryptionKey(IResolvable)
//  .engineVersion(java.lang.String)
//  .engineVersion(IResolvable)
//  .hiddenZoneId(java.lang.String)
//  .hiddenZoneId(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .privateConnections(IResolvable)
//  .privateConnections(PrivateConnectionsProperty)
//  .provisionedIops(java.lang.Number)
//  .provisionedIops(IResolvable)
//  .readonlyReplicas(java.lang.Number)
//  .readonlyReplicas(IResolvable)
//  .replicationFactor(java.lang.Number)
//  .replicationFactor(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .restoreTime(java.lang.String)
//  .restoreTime(IResolvable)
//  .restoreType(java.lang.Number)
//  .restoreType(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)
//  .srcRegion(java.lang.String)
//  .srcRegion(IResolvable)
//  .sslOptions(IResolvable)
//  .sslOptions(SSLOptionsProperty)
//  .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();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

dbInstanceClass^Required

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

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

dbInstanceStorage^Required

• 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

accountPassword^Optional

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

Property accountPassword: The password of the root account.

The password must meet the following requirements:

• It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
• Special characters include !@#$%^&*()_+-=
• It must be 8 to 32 characters in length.

auditPolicyOptions^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR AuditPolicyOptionsProperty

Property auditPolicyOptions: Audit policy options.

autoRenew^Optional

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

Property autoRenew: Specifies whether to enable auto-renewal for the instance.

Valid values:

• true: Auto-renewal is enabled.
• false: Auto-renewal is disabled. You must manually renew the instance. This is the default value.

This parameter is optional and takes effect only when you set the ChargeType parameter to PrePaid.

backupId^Optional

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

Property backupId: The backup point ID.

To query the backup point ID, call the DescribeBackups operation.

You must specify this parameter and the SrcDBInstanceId parameter only when you clone an instance based on a backup point.

backupPolicyOptions^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR BackupPolicyOptionsProperty

Property backupPolicyOptions: Backup policy options.

businessInfo^Optional

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

Property businessInfo: The business information.

It is an additional parameter.

chargeType^Optional

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

clusterId^Optional

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

Property clusterId: The dedicated cluster ID.

couponNo^Optional

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

Property couponNo: Specifies whether to use a coupon.

Valid values:

• default or null (default): Uses a coupon.
• youhuiquan_promotion_option_id_for_blank: Does not use a coupon.

databaseNames^Optional

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

Property databaseNames: The database name.

When you clone an instance, you can specify this parameter to clone specific databases. If you do not specify this parameter, all databases of the instance are cloned.

dbInstanceDescription^Optional

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

Property dbInstanceDescription: The name of the instance.

The name must meet the following requirements:

• It must start with a Chinese character or a letter.
• It can contain digits, Chinese characters, letters, underscores (_), periods (.), and hyphens (-).
• It must be 2 to 256 characters in length.

dbInstanceReleaseProtection^Optional

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

Property dbInstanceReleaseProtection: Enables instance release protection.

Values:

• true: Enabled.
• false: Not enabled.

encrypted^Optional

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

Property encrypted: Whether to enable cloud disk encryption.

encryptionKey^Optional

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

Property encryptionKey: Custom key ID.

engineVersion^Optional

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

Property engineVersion: The database version.

Valid values:

• 8.0
• 7.0
• 6.0
• 5.0
• 4.4
• 4.2
• 4.0

• When you clone an instance by calling this operation, the value of this parameter must be the same as that of the source instance.

hiddenZoneId^Optional

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

period^Optional

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

Property period: The subscription duration of the instance.

Unit: month. Valid values: 1 to 9 (integer), 12, 24, 36, and 60.

This parameter is required and takes effect only when you set the ChargeType parameter to PrePaid.

privateConnections^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR PrivateConnectionsProperty

Property privateConnections: Connection configs of private connection.

provisionedIops^Optional

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

Property provisionedIops: Provisioned IOPS.

The value range is 0 to 50000.

readonlyReplicas^Optional

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

Property readonlyReplicas: The number of read-only nodes in the replica set instance.

Valid values are integers from 0 to 5. The default value is 0.

replicationFactor^Optional

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

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the resource group.

restoreTime^Optional

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

restoreType^Optional

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

Property restoreType: The method to restore an instance from a backup.

• 0: Restores the instance to a specified backup set.
• 1: Restores the instance to a specified point in time.
• 2: Restores a released instance to a specified backup set.
• 3: Restores the instance to a specified geo-redundant backup set.

secondaryZoneId^Optional

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

securityGroupId^Optional

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

securityIpArray^Optional

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

Property securityIpArray: Security ips to add or remove.

Update to this property will cover the current security ips.

srcDbInstanceId^Optional

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

Property srcDbInstanceId: The source instance ID.

This parameter is required only when you clone an instance by calling this operation. You must also specify the RestoreTime parameter.

srcRegion^Optional

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

Property srcRegion: The source instance region.

• When the backup recovery type is 2 or 3, this parameter is required.

sslOptions^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR SSLOptionsProperty

Property sslOptions: SSL options.

storageEngine^Optional

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

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

storageType^Optional

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

tags^Optional

• Type: java.util.List<TagsProperty>

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.

tdeStatus^Optional

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

vpcId^Optional

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

Property vpcId: The VPC id to create mongodb instance.

vpcPasswordFree^Optional

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

vSwitchId^Optional

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

Property vSwitchId: The vSwitch Id to create mongodb instance.

zoneId^Optional

• 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

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

grantFullAccess

public ManagedPolicy grantFullAccess(IPrincipal identity)

Grant an RAM principal (Role/Group/User) full control over this MongoDB instance.

identity^Required

• Type: com.aliyun.ros.cdk.ram.IPrincipal

The principal.

grantList

public ManagedPolicy grantList(IPrincipal identity)

Grant an RAM principal (Role/Group/User) permission to list resources for this MongoDB instance.

identity^Required

• Type: com.aliyun.ros.cdk.ram.IPrincipal

The principal.

grantRead

public ManagedPolicy grantRead(IPrincipal identity)

Grant an RAM principal (Role/Group/User) permission to list and get resources for this MongoDB instance.

identity^Required

• Type: com.aliyun.ros.cdk.ram.IPrincipal

The principal.

grantReadWrite

public ManagedPolicy grantReadWrite(IPrincipal identity)

Grant an RAM principal (Role/Group/User) permission to create, update and delete resources for this MongoDB instance.

identity^Required

• Type: com.aliyun.ros.cdk.ram.IPrincipal

The principal.

Static Functions

isConstruct

import com.aliyun.ros.cdk.mongodb.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

attrArn^Required

public java.lang.Object getAttrArn();

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attrConnectionUri^Required

public java.lang.Object getAttrConnectionUri();

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

Attribute ConnectionURI: Connection uri.

attrDbInstanceId^Required

public java.lang.Object getAttrDbInstanceId();

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

Attribute DBInstanceId: The instance id of created mongodb instance.

attrDbInstanceStatus^Required

public java.lang.Object getAttrDbInstanceStatus();

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

Attribute DBInstanceStatus: Status of mongodb instance.

attrOrderId^Required

public java.lang.Object getAttrOrderId();

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

Attribute OrderId: Order Id of created instance.

attrReplicaSetName^Required

public java.lang.Object getAttrReplicaSetName();

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

Attribute ReplicaSetName: Name of replica set.

props^Required

public InstanceProps getProps();

• Type: InstanceProps