Skip to content

ShardingInstanceProps

Properties for defining a ShardingInstance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-mongodb-shardinginstance

Initializer 

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

Properties

Name Type Description
configServer com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConfigServerProperty> Property configServer:.
mongos com.aliyun.ros.cdk.core.IResolvable OR java.util.ListMongosProperty> Property mongos:.
replicaSet com.aliyun.ros.cdk.core.IResolvable OR java.util.ListReplicaSetProperty> Property replicaSet:.
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.
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.
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.
protocolType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property protocolType: Protocol type.
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.
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.
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.

configServerRequired 

public java.lang.Object getConfigServer();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListConfigServerProperty>

Property configServer:.

mongosRequired 

public java.lang.Object getMongos();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListMongosProperty>

Property mongos:.

replicaSetRequired 

public java.lang.Object getReplicaSet();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListReplicaSetProperty>

Property replicaSet:.

accountPasswordOptional 

public java.lang.Object getAccountPassword();
  • 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 

public java.lang.Object getAutoRenew();
  • 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.

chargeTypeOptional 

public java.lang.Object getChargeType();
  • 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.

dbInstanceDescriptionOptional 

public java.lang.Object getDbInstanceDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceDescription: Description of created database instance.

engineVersionOptional 

public java.lang.Object getEngineVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property engineVersion: Database instance version.

hiddenZoneIdOptional 

public java.lang.Object getHiddenZoneId();
  • 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 

public java.lang.Object getPeriod();
  • 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.

protocolTypeOptional 

public java.lang.Object getProtocolType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property protocolType: Protocol type.

Valid value: mongodb or dynamodb.

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

restoreTimeOptional 

public java.lang.Object getRestoreTime();
  • 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 

public java.lang.Object getSecondaryZoneId();
  • 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.

securityIpArrayOptional 

public java.lang.Object getSecurityIpArray();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property securityIpArray: Security ips to add or remove.

srcDbInstanceIdOptional 

public java.lang.Object getSrcDbInstanceId();
  • 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 

public java.lang.Object getStorageEngine();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

storageTypeOptional 

public java.lang.Object getStorageType();
  • 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 

public java.util.List<TagsProperty> getTags();

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 

public java.lang.Object getTdeStatus();
  • 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 

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The VPC id to create mongodb instance.

vSwitchIdOptional 

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The vSwitch Id to create mongodb instance.

zoneIdOptional 

public java.lang.Object getZoneId();
  • 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.