ShardingInstanceProps

Properties for defining a ShardingInstance.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Mongodb;
new ShardingInstanceProps {
    object ConfigServer,
    object Mongos,
    object ReplicaSet,
    object AccountPassword = null,
    object AutoRenew = null,
    object ChargeType = null,
    object DbInstanceDescription = null,
    object EngineVersion = null,
    object HiddenZoneId = null,
    object NetworkType = null,
    object Period = null,
    object ProtocolType = null,
    object ResourceGroupId = null,
    object RestoreTime = null,
    object SecondaryZoneId = null,
    object SecurityIpArray = null,
    object SrcDbInstanceId = null,
    object StorageEngine = null,
    object StorageType = null,
    TagsProperty[] Tags = null,
    object TdeStatus = null,
    object VpcId = null,
    object VSwitchId = null,
    object ZoneId = null
};

Properties

Name	Type	Description
ConfigServer	object	Property configServer:.
Mongos	object	Property mongos:.
ReplicaSet	object	Property replicaSet:.
AccountPassword	object	Property accountPassword: Root account password, can contain the letters, numbers or underscores the composition, length of 6~32 bit.
AutoRenew	object	Property autoRenew: Indicates whether automatic renewal is enabled for the instance.
ChargeType	object	Property chargeType: The billing method of the instance.values:PostPaid: Pay-As-You-Go.PrePaid: Subscription.Default value: PostPaid.
DbInstanceDescription	object	Property dbInstanceDescription: Description of created database instance.
EngineVersion	object	Property engineVersion: Database instance version.
HiddenZoneId	object	Property hiddenZoneId: Configure the zone where the hidden node resides to implement multi-availability zone deployment.
NetworkType	object	Property networkType: The instance network type.
Period	object	Property period: The subscription period of the instance.Default Unit: Month.Valid values: [1~9], 12, 24, 36. Default to 1.
ProtocolType	object	Property protocolType: Protocol type.
ResourceGroupId	object	Property resourceGroupId: The ID of the resource group.
RestoreTime	object	Property restoreTime: The time to restore the cloned instance to.
SecondaryZoneId	object	Property secondaryZoneId: Configure the zone where the secondary node resides to implement multi-availability zone deployment.
SecurityIpArray	object	Property securityIpArray: Security ips to add or remove.
SrcDbInstanceId	object	Property srcDbInstanceId: Create an instance of the backup set based on an instance.
StorageEngine	object	Property storageEngine: Database storage engine.Support WiredTiger, RocksDB, TerarkDB.
StorageType	object	Property storageType: The storage type of the instance.
Tags	TagsProperty[]	Property tags: Tags to attach to instance.
TdeStatus	object	Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).
VpcId	object	Property vpcId: The VPC id to create mongodb instance.
VSwitchId	object	Property vSwitchId: The vSwitch Id to create mongodb instance.
ZoneId	object	Property zoneId: On which zone to create the instance.

---

ConfigServer^Required

public object ConfigServer { get; set; }

• Type: object

Property configServer:.

---

Mongos^Required

public object Mongos { get; set; }

• Type: object

Property mongos:.

---

ReplicaSet^Required

public object ReplicaSet { get; set; }

• Type: object

Property replicaSet:.

---

AccountPassword^Optional

public object AccountPassword { get; set; }

• Type: object

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

---

AutoRenew^Optional

public object AutoRenew { get; set; }

• Type: object

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.

---

ChargeType^Optional

public object ChargeType { get; set; }

• Type: object

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

---

DbInstanceDescription^Optional

public object DbInstanceDescription { get; set; }

• Type: object

Property dbInstanceDescription: Description of created database instance.

---

EngineVersion^Optional

public object EngineVersion { get; set; }

• Type: object

Property engineVersion: Database instance version.

---

HiddenZoneId^Optional

public object HiddenZoneId { get; set; }

• Type: object

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.

---

NetworkType^Optional

public object NetworkType { get; set; }

• Type: object

Property networkType: The instance network type.

Support 'CLASSIC' and 'VPC' only, default is 'CLASSIC'.

---

Period^Optional

public object Period { get; set; }

• Type: object

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

---

ProtocolType^Optional

public object ProtocolType { get; set; }

• Type: object

Property protocolType: Protocol type.

Valid value: mongodb or dynamodb.

---

ResourceGroupId^Optional

public object ResourceGroupId { get; set; }

• Type: object

Property resourceGroupId: The ID of the resource group.

---

RestoreTime^Optional

public object RestoreTime { get; set; }

• Type: object

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

public object SecondaryZoneId { get; set; }

• Type: object

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

public object SecurityIpArray { get; set; }

• Type: object

Property securityIpArray: Security ips to add or remove.

---

SrcDbInstanceId^Optional

public object SrcDbInstanceId { get; set; }

• Type: object

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

---

StorageEngine^Optional

public object StorageEngine { get; set; }

• Type: object

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

---

StorageType^Optional

public object StorageType { get; set; }

• Type: object

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

public TagsProperty[] Tags { get; set; }

• Type: 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

public object TdeStatus { get; set; }

• Type: object

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

public object VpcId { get; set; }

• Type: object

Property vpcId: The VPC id to create mongodb instance.

---

VSwitchId^Optional

public object VSwitchId { get; set; }

• Type: object

Property vSwitchId: The vSwitch Id to create mongodb instance.

---

ZoneId^Optional

public object ZoneId { get; set; }

• Type: object

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.

---