com.tencentcloudapi.mongodb.v20190725.models

Class CreateDBInstanceRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mongodb.v20190725.models.CreateDBInstanceRequest

public class CreateDBInstanceRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateDBInstanceRequest()
CreateDBInstanceRequest(CreateDBInstanceRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Long	getAutoRenewFlag() Get Auto-renewal flag.
Long	getAutoVoucher() Get Whether to automatically use a voucher.
String[]	getAvailabilityZoneList() Get AZ list when multi-AZ deployment is enabled.
Long	getClone() Get Instance type.
String	getClusterType() Get Instance type.
String	getFather() Get Primary instance ID.
Long	getGoodsNum() Get Number of instances.
String	getHiddenZone() Get The AZ where the hidden node resides.
String	getInstanceName() Get Instance name, which can contain up to 60 letters, digits, or symbols (_-).
String	getMachineCode() Get Server type.
Long	getMemory() Get Instance memory size in GB.
Long	getMongosCpu() Get The number of mongos CPUs, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger.
Long	getMongosMemory() Get The size of mongos memory, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger.
Long	getMongosNodeNum() Get The number of mongos routers, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger.
String	getMongoVersion() Get Version number.
Long	getNodeNum() Get The number of nodes in each replica set.
String	getPassword() Get Instance password.
Long	getPeriod() Get Instance validity period in months.
Long	getProjectId() Get Project ID.
String[]	getReadonlyNodeAvailabilityZoneList() Get The AZ where the read-only node is deployed
Long	getReadonlyNodeNum() Get Number of read-only nodes.
Long	getReplicateSetNum() Get Number of replica sets.
String	getRestoreTime() Get The point in time to which the cloned instance will be rolled back.
String[]	getSecurityGroup() Get Security group.
String	getSubnetId() Get VPC subnet ID.
TagInfo[]	getTags() Get Instance tag information.
Long	getVolume() Get Instance disk size in GB.
String	getVpcId() Get VPC ID.
String	getZone() Get AZ in the format of ap-guangzhou-2.
void	setAutoRenewFlag(Long AutoRenewFlag) Set Auto-renewal flag.
void	setAutoVoucher(Long AutoVoucher) Set Whether to automatically use a voucher.
void	setAvailabilityZoneList(String[] AvailabilityZoneList) Set AZ list when multi-AZ deployment is enabled.
void	setClone(Long Clone) Set Instance type.
void	setClusterType(String ClusterType) Set Instance type.
void	setFather(String Father) Set Primary instance ID.
void	setGoodsNum(Long GoodsNum) Set Number of instances.
void	setHiddenZone(String HiddenZone) Set The AZ where the hidden node resides.
void	setInstanceName(String InstanceName) Set Instance name, which can contain up to 60 letters, digits, or symbols (_-).
void	setMachineCode(String MachineCode) Set Server type.
void	setMemory(Long Memory) Set Instance memory size in GB.
void	setMongosCpu(Long MongosCpu) Set The number of mongos CPUs, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger.
void	setMongosMemory(Long MongosMemory) Set The size of mongos memory, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger.
void	setMongosNodeNum(Long MongosNodeNum) Set The number of mongos routers, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger.
void	setMongoVersion(String MongoVersion) Set Version number.
void	setNodeNum(Long NodeNum) Set The number of nodes in each replica set.
void	setPassword(String Password) Set Instance password.
void	setPeriod(Long Period) Set Instance validity period in months.
void	setProjectId(Long ProjectId) Set Project ID.
void	setReadonlyNodeAvailabilityZoneList(String[] ReadonlyNodeAvailabilityZoneList) Set The AZ where the read-only node is deployed
void	setReadonlyNodeNum(Long ReadonlyNodeNum) Set Number of read-only nodes.
void	setReplicateSetNum(Long ReplicateSetNum) Set Number of replica sets.
void	setRestoreTime(String RestoreTime) Set The point in time to which the cloned instance will be rolled back.
void	setSecurityGroup(String[] SecurityGroup) Set Security group.
void	setSubnetId(String SubnetId) Set VPC subnet ID.
void	setTags(TagInfo[] Tags) Set Instance tag information.
void	setVolume(Long Volume) Set Instance disk size in GB.
void	setVpcId(String VpcId) Set VPC ID.
void	setZone(String Zone) Set AZ in the format of ap-guangzhou-2.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateDBInstanceRequest

public CreateDBInstanceRequest()

CreateDBInstanceRequest

public CreateDBInstanceRequest(CreateDBInstanceRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getNodeNum

public Long getNodeNum()

Get The number of nodes in each replica set. The value range is subject to the response parameter of the `DescribeSpecInfo` API.

Returns:

NodeNum The number of nodes in each replica set. The value range is subject to the response parameter of the `DescribeSpecInfo` API.

setNodeNum

public void setNodeNum(Long NodeNum)

Set The number of nodes in each replica set. The value range is subject to the response parameter of the `DescribeSpecInfo` API.

Parameters:

NodeNum - The number of nodes in each replica set. The value range is subject to the response parameter of the `DescribeSpecInfo` API.

getMemory

public Long getMemory()

Get Instance memory size in GB.

Returns:

Memory Instance memory size in GB.

setMemory

public void setMemory(Long Memory)

Set Instance memory size in GB.

Parameters:

Memory - Instance memory size in GB.

getVolume

public Long getVolume()

Get Instance disk size in GB.

Returns:

Volume Instance disk size in GB.

setVolume

public void setVolume(Long Volume)

Set Instance disk size in GB.

Parameters:

Volume - Instance disk size in GB.

getMongoVersion

public String getMongoVersion()

Get Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition; MONGO_42_WT: MongoDB 4.2 WiredTiger Edition.

Returns:

MongoVersion Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition; MONGO_42_WT: MongoDB 4.2 WiredTiger Edition.

setMongoVersion

public void setMongoVersion(String MongoVersion)

Set Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition; MONGO_42_WT: MongoDB 4.2 WiredTiger Edition.

Parameters:

MongoVersion - Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition; MONGO_42_WT: MongoDB 4.2 WiredTiger Edition.

getGoodsNum

public Long getGoodsNum()

Get Number of instances. Minimum value: 1. Maximum value: 10.

Returns:

GoodsNum Number of instances. Minimum value: 1. Maximum value: 10.

setGoodsNum

public void setGoodsNum(Long GoodsNum)

Set Number of instances. Minimum value: 1. Maximum value: 10.

Parameters:

GoodsNum - Number of instances. Minimum value: 1. Maximum value: 10.

getZone

public String getZone()

Get AZ in the format of ap-guangzhou-2. If multi-AZ deployment is enabled, this parameter refers to the primary AZ and must be one of the values of `AvailabilityZoneList`.

Returns:

Zone AZ in the format of ap-guangzhou-2. If multi-AZ deployment is enabled, this parameter refers to the primary AZ and must be one of the values of `AvailabilityZoneList`.

setZone

public void setZone(String Zone)

Set AZ in the format of ap-guangzhou-2. If multi-AZ deployment is enabled, this parameter refers to the primary AZ and must be one of the values of `AvailabilityZoneList`.

Parameters:

Zone - AZ in the format of ap-guangzhou-2. If multi-AZ deployment is enabled, this parameter refers to the primary AZ and must be one of the values of `AvailabilityZoneList`.

getPeriod

public Long getPeriod()

Get Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.

Returns:

Period Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.

setPeriod

public void setPeriod(Long Period)

Set Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.

Parameters:

Period - Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.

getMachineCode

public String getMachineCode()

Get Server type. Valid values: HIO (high IO), HIO10G (10-gigabit high IO), STDS5 (standard).

Returns:

MachineCode Server type. Valid values: HIO (high IO), HIO10G (10-gigabit high IO), STDS5 (standard).

setMachineCode

public void setMachineCode(String MachineCode)

Set Server type. Valid values: HIO (high IO), HIO10G (10-gigabit high IO), STDS5 (standard).

Parameters:

MachineCode - Server type. Valid values: HIO (high IO), HIO10G (10-gigabit high IO), STDS5 (standard).

getClusterType

public String getClusterType()

Get Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).

Returns:

ClusterType Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).

setClusterType

public void setClusterType(String ClusterType)

Set Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).

Parameters:

ClusterType - Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).

getReplicateSetNum

public Long getReplicateSetNum()

Get Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the `DescribeSpecInfo` API; to create a single-node instance, set this parameter to 0.

Returns:

ReplicateSetNum Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the `DescribeSpecInfo` API; to create a single-node instance, set this parameter to 0.

setReplicateSetNum

public void setReplicateSetNum(Long ReplicateSetNum)

Set Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the `DescribeSpecInfo` API; to create a single-node instance, set this parameter to 0.

Parameters:

ReplicateSetNum - Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the `DescribeSpecInfo` API; to create a single-node instance, set this parameter to 0.

getProjectId

public Long getProjectId()

Get Project ID. If this parameter is not set, the default project will be used.

Returns:

ProjectId Project ID. If this parameter is not set, the default project will be used.

setProjectId

public void setProjectId(Long ProjectId)

Set Project ID. If this parameter is not set, the default project will be used.

Parameters:

ProjectId - Project ID. If this parameter is not set, the default project will be used.

getVpcId

public String getVpcId()

Get VPC ID. If this parameter is not set, the classic network will be used. Please use the `DescribeVpcs` API to query the VPC list.

Returns:

VpcId VPC ID. If this parameter is not set, the classic network will be used. Please use the `DescribeVpcs` API to query the VPC list.

setVpcId

public void setVpcId(String VpcId)

Set VPC ID. If this parameter is not set, the classic network will be used. Please use the `DescribeVpcs` API to query the VPC list.

Parameters:

VpcId - VPC ID. If this parameter is not set, the classic network will be used. Please use the `DescribeVpcs` API to query the VPC list.

getSubnetId

public String getSubnetId()

Get VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. Please use the `DescribeSubnets` API to query the subnet list.

Returns:

SubnetId VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. Please use the `DescribeSubnets` API to query the subnet list.

setSubnetId

public void setSubnetId(String SubnetId)

Set VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. Please use the `DescribeSubnets` API to query the subnet list.

Parameters:

SubnetId - VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. Please use the `DescribeSubnets` API to query the subnet list.

getPassword

public String getPassword()

Get Instance password. If it is left empty, the password is in the default format of "instance ID+@+root account UIN". For example, if the instance ID is "cmgo-higv73ed" and the root account UIN "100000001", the instance password will be "cmgo-higv73ed@100000001". The custom password must contain 8-32 characters in at least two of the following types: letters, digits, and symbols (!@#%^*()_).

Returns:

Password Instance password. If it is left empty, the password is in the default format of "instance ID+@+root account UIN". For example, if the instance ID is "cmgo-higv73ed" and the root account UIN "100000001", the instance password will be "cmgo-higv73ed@100000001". The custom password must contain 8-32 characters in at least two of the following types: letters, digits, and symbols (!@#%^*()_).

setPassword

public void setPassword(String Password)

Set Instance password. If it is left empty, the password is in the default format of "instance ID+@+root account UIN". For example, if the instance ID is "cmgo-higv73ed" and the root account UIN "100000001", the instance password will be "cmgo-higv73ed@100000001". The custom password must contain 8-32 characters in at least two of the following types: letters, digits, and symbols (!@#%^*()_).

Parameters:

Password - Instance password. If it is left empty, the password is in the default format of "instance ID+@+root account UIN". For example, if the instance ID is "cmgo-higv73ed" and the root account UIN "100000001", the instance password will be "cmgo-higv73ed@100000001". The custom password must contain 8-32 characters in at least two of the following types: letters, digits, and symbols (!@#%^*()_).

getTags

public TagInfo[] getTags()

Get Instance tag information.

Returns:

Tags Instance tag information.

setTags

public void setTags(TagInfo[] Tags)

Set Instance tag information.

Parameters:

Tags - Instance tag information.

getAutoRenewFlag

public Long getAutoRenewFlag()

Get Auto-renewal flag. Valid values: 0 (auto-renewal not enabled), 1 (auto-renewal enabled). Default value: 0.

Returns:

AutoRenewFlag Auto-renewal flag. Valid values: 0 (auto-renewal not enabled), 1 (auto-renewal enabled). Default value: 0.

setAutoRenewFlag

public void setAutoRenewFlag(Long AutoRenewFlag)

Set Auto-renewal flag. Valid values: 0 (auto-renewal not enabled), 1 (auto-renewal enabled). Default value: 0.

Parameters:

AutoRenewFlag - Auto-renewal flag. Valid values: 0 (auto-renewal not enabled), 1 (auto-renewal enabled). Default value: 0.

getAutoVoucher

public Long getAutoVoucher()

Get Whether to automatically use a voucher. Valid values: 1 (yes), 0 (no). Default value: 0.

Returns:

AutoVoucher Whether to automatically use a voucher. Valid values: 1 (yes), 0 (no). Default value: 0.

setAutoVoucher

public void setAutoVoucher(Long AutoVoucher)

Set Whether to automatically use a voucher. Valid values: 1 (yes), 0 (no). Default value: 0.

Parameters:

AutoVoucher - Whether to automatically use a voucher. Valid values: 1 (yes), 0 (no). Default value: 0.

getClone

public Long getClone()

Get Instance type. Valid values: `1` (primary instance), `2` (temp instance), `3` (read-only instance), `4` (disaster recovery instance), `5` (cloned instance).

Returns:

Clone Instance type. Valid values: `1` (primary instance), `2` (temp instance), `3` (read-only instance), `4` (disaster recovery instance), `5` (cloned instance).

setClone

public void setClone(Long Clone)

Set Instance type. Valid values: `1` (primary instance), `2` (temp instance), `3` (read-only instance), `4` (disaster recovery instance), `5` (cloned instance).

Parameters:

Clone - Instance type. Valid values: `1` (primary instance), `2` (temp instance), `3` (read-only instance), `4` (disaster recovery instance), `5` (cloned instance).

getFather

public String getFather()

Get Primary instance ID. It is required for read-only, disaster recovery, and cloned instances.

Returns:

Father Primary instance ID. It is required for read-only, disaster recovery, and cloned instances.

setFather

public void setFather(String Father)

Set Primary instance ID. It is required for read-only, disaster recovery, and cloned instances.

Parameters:

Father - Primary instance ID. It is required for read-only, disaster recovery, and cloned instances.

getSecurityGroup

public String[] getSecurityGroup()

Get Security group.

Returns:

SecurityGroup Security group.

setSecurityGroup

public void setSecurityGroup(String[] SecurityGroup)

Set Security group.

Parameters:

SecurityGroup - Security group.

getRestoreTime

public String getRestoreTime()

Get The point in time to which the cloned instance will be rolled back. This parameter is required for a cloned instance. The point in time in the format of 2021-08-13 16:30:00 must be within the last seven days.

Returns:

RestoreTime The point in time to which the cloned instance will be rolled back. This parameter is required for a cloned instance. The point in time in the format of 2021-08-13 16:30:00 must be within the last seven days.

setRestoreTime

public void setRestoreTime(String RestoreTime)

Set The point in time to which the cloned instance will be rolled back. This parameter is required for a cloned instance. The point in time in the format of 2021-08-13 16:30:00 must be within the last seven days.

Parameters:

RestoreTime - The point in time to which the cloned instance will be rolled back. This parameter is required for a cloned instance. The point in time in the format of 2021-08-13 16:30:00 must be within the last seven days.

getInstanceName

public String getInstanceName()

Get Instance name, which can contain up to 60 letters, digits, or symbols (_-).

Returns:

InstanceName Instance name, which can contain up to 60 letters, digits, or symbols (_-).

setInstanceName

public void setInstanceName(String InstanceName)

Set Instance name, which can contain up to 60 letters, digits, or symbols (_-).

Parameters:

InstanceName - Instance name, which can contain up to 60 letters, digits, or symbols (_-).

getAvailabilityZoneList

public String[] getAvailabilityZoneList()

Get AZ list when multi-AZ deployment is enabled. For the specific purchasable versions which support multi-AZ deployment, please see the return result of the `DescribeSpecInfo` API. Notes: 1. Nodes of a multi-AZ instance must be deployed across three AZs. 2. To ensure a successful cross-AZ switch, you should not deploy most of the nodes to the same AZ. (For example, a three-node sharded cluster instance does not support deploying two or more nodes in the same AZ.) 3. MongoDB 4.2 and later versions do not support multi-AZ deployment. 4. Read-Only and disaster recovery instances do not support multi-AZ deployment. 5. Instances in the classic network do not support multi-AZ deployment.

Returns:

AvailabilityZoneList AZ list when multi-AZ deployment is enabled. For the specific purchasable versions which support multi-AZ deployment, please see the return result of the `DescribeSpecInfo` API. Notes: 1. Nodes of a multi-AZ instance must be deployed across three AZs. 2. To ensure a successful cross-AZ switch, you should not deploy most of the nodes to the same AZ. (For example, a three-node sharded cluster instance does not support deploying two or more nodes in the same AZ.) 3. MongoDB 4.2 and later versions do not support multi-AZ deployment. 4. Read-Only and disaster recovery instances do not support multi-AZ deployment. 5. Instances in the classic network do not support multi-AZ deployment.

setAvailabilityZoneList

public void setAvailabilityZoneList(String[] AvailabilityZoneList)

Set AZ list when multi-AZ deployment is enabled. For the specific purchasable versions which support multi-AZ deployment, please see the return result of the `DescribeSpecInfo` API. Notes: 1. Nodes of a multi-AZ instance must be deployed across three AZs. 2. To ensure a successful cross-AZ switch, you should not deploy most of the nodes to the same AZ. (For example, a three-node sharded cluster instance does not support deploying two or more nodes in the same AZ.) 3. MongoDB 4.2 and later versions do not support multi-AZ deployment. 4. Read-Only and disaster recovery instances do not support multi-AZ deployment. 5. Instances in the classic network do not support multi-AZ deployment.

Parameters:

AvailabilityZoneList - AZ list when multi-AZ deployment is enabled. For the specific purchasable versions which support multi-AZ deployment, please see the return result of the `DescribeSpecInfo` API. Notes: 1. Nodes of a multi-AZ instance must be deployed across three AZs. 2. To ensure a successful cross-AZ switch, you should not deploy most of the nodes to the same AZ. (For example, a three-node sharded cluster instance does not support deploying two or more nodes in the same AZ.) 3. MongoDB 4.2 and later versions do not support multi-AZ deployment. 4. Read-Only and disaster recovery instances do not support multi-AZ deployment. 5. Instances in the classic network do not support multi-AZ deployment.

getMongosCpu

public Long getMongosCpu()

Get The number of mongos CPUs, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.

Returns:

MongosCpu The number of mongos CPUs, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.

setMongosCpu

public void setMongosCpu(Long MongosCpu)

Set The number of mongos CPUs, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.

Parameters:

MongosCpu - The number of mongos CPUs, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.

getMongosMemory

public Long getMongosMemory()

Get The size of mongos memory, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.

Returns:

MongosMemory The size of mongos memory, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.

setMongosMemory

public void setMongosMemory(Long MongosMemory)

Set The size of mongos memory, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.

Parameters:

MongosMemory - The size of mongos memory, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.

getMongosNodeNum

public Long getMongosNodeNum()

Get The number of mongos routers, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. Note: please purchase 3-32 mongos routers for high availability.

Returns:

MongosNodeNum The number of mongos routers, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. Note: please purchase 3-32 mongos routers for high availability.

setMongosNodeNum

public void setMongosNodeNum(Long MongosNodeNum)

Set The number of mongos routers, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. Note: please purchase 3-32 mongos routers for high availability.

Parameters:

MongosNodeNum - The number of mongos routers, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. Note: please purchase 3-32 mongos routers for high availability.

getReadonlyNodeNum

public Long getReadonlyNodeNum()

Get Number of read-only nodes. Value range: 2-7.

Returns:

ReadonlyNodeNum Number of read-only nodes. Value range: 2-7.

setReadonlyNodeNum

public void setReadonlyNodeNum(Long ReadonlyNodeNum)

Set Number of read-only nodes. Value range: 2-7.

Parameters:

ReadonlyNodeNum - Number of read-only nodes. Value range: 2-7.

getReadonlyNodeAvailabilityZoneList

public String[] getReadonlyNodeAvailabilityZoneList()

Get The AZ where the read-only node is deployed

Returns:

ReadonlyNodeAvailabilityZoneList The AZ where the read-only node is deployed

setReadonlyNodeAvailabilityZoneList

public void setReadonlyNodeAvailabilityZoneList(String[] ReadonlyNodeAvailabilityZoneList)

Set The AZ where the read-only node is deployed

Parameters:

ReadonlyNodeAvailabilityZoneList - The AZ where the read-only node is deployed

getHiddenZone

public String getHiddenZone()

Get The AZ where the hidden node resides. It is required for cross-AZ instances.

Returns:

HiddenZone The AZ where the hidden node resides. It is required for cross-AZ instances.

setHiddenZone

public void setHiddenZone(String HiddenZone)

Set The AZ where the hidden node resides. It is required for cross-AZ instances.

Parameters:

HiddenZone - The AZ where the hidden node resides. It is required for cross-AZ instances.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel