ShardingInstance

• Implements: IShardingInstance

This class encapsulates and extends the ROS resource type ALIYUN::MONGODB::ShardingInstance.

Initializers

import com.aliyun.ros.cdk.mongodb.ShardingInstance;
ShardingInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .configServer(IResolvable)
    .configServer(java.util.List<IResolvable)
    .configServer(ConfigServerProperty>)
    .mongos(IResolvable)
    .mongos(java.util.List<IResolvable)
    .mongos(MongosProperty>)
    .replicaSet(IResolvable)
    .replicaSet(java.util.List<IResolvable)
    .replicaSet(ReplicaSetProperty>)
//  .accountPassword(java.lang.String)
//  .accountPassword(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .chargeType(java.lang.String)
//  .chargeType(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)
//  .protocolType(java.lang.String)
//  .protocolType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .restoreTime(java.lang.String)
//  .restoreTime(IResolvable)
//  .secondaryZoneId(java.lang.String)
//  .secondaryZoneId(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)
//  .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

configServer^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConfigServerProperty>

Property configServer: The information of Configserver nodes.

mongos^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListMongosProperty>

Property mongos: The information of Mongos nodes.

replicaSet^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListReplicaSetProperty>

Property replicaSet: The information of shard nodes.

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.

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.

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.

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.

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.

protocolType^Optional

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

Property protocolType: Protocol type.

Valid value: mongodb or dynamodb.

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.

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.

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.

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.

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

Static Functions

isConstruct

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

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.

props^Required

public ShardingInstanceProps getProps();

• Type: ShardingInstanceProps