ShardingInstanceProps

Properties for defining a ShardingInstance.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkmongodb"
&alicloudroscdkmongodb.ShardingInstanceProps {
    ConfigServer: interface{},
    Mongos: interface{},
    ReplicaSet: interface{},
    AccountPassword: interface{},
    AutoRenew: interface{},
    ChargeType: interface{},
    DbInstanceDescription: interface{},
    EngineVersion: interface{},
    HiddenZoneId: interface{},
    Period: interface{},
    ProtocolType: interface{},
    ResourceGroupId: interface{},
    RestoreTime: interface{},
    SecondaryZoneId: interface{},
    SecurityIpArray: interface{},
    SrcDbInstanceId: interface{},
    StorageEngine: interface{},
    StorageType: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkmongodb.RosShardingInstance.TagsProperty,
    TdeStatus: interface{},
    VpcId: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
}

Properties

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

---

ConfigServer^Required

ConfigServer interface{}

• Type: interface{}

Property configServer:.

---

Mongos^Required

Mongos interface{}

• Type: interface{}

Property mongos:.

---

ReplicaSet^Required

ReplicaSet interface{}

• Type: interface{}

Property replicaSet:.

---

AccountPassword^Optional

AccountPassword interface{}

• Type: interface{}

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

---

AutoRenew^Optional

AutoRenew interface{}

• Type: interface{}

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

ChargeType interface{}

• Type: interface{}

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

---

DbInstanceDescription^Optional

DbInstanceDescription interface{}

• Type: interface{}

Property dbInstanceDescription: Description of created database instance.

---

EngineVersion^Optional

EngineVersion interface{}

• Type: interface{}

Property engineVersion: Database instance version.

---

HiddenZoneId^Optional

HiddenZoneId interface{}

• Type: interface{}

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

Period interface{}

• Type: interface{}

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

---

ProtocolType^Optional

ProtocolType interface{}

• Type: interface{}

Property protocolType: Protocol type.

Valid value: mongodb or dynamodb.

---

ResourceGroupId^Optional

ResourceGroupId interface{}

• Type: interface{}

Property resourceGroupId: The ID of the resource group.

---

RestoreTime^Optional

RestoreTime interface{}

• Type: interface{}

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

SecondaryZoneId interface{}

• Type: interface{}

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

SecurityIpArray interface{}

• Type: interface{}

Property securityIpArray: Security ips to add or remove.

---

SrcDbInstanceId^Optional

SrcDbInstanceId interface{}

• Type: interface{}

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

---

StorageEngine^Optional

StorageEngine interface{}

• Type: interface{}

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

---

StorageType^Optional

StorageType interface{}

• Type: interface{}

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

Tags *[]TagsProperty

• 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

TdeStatus interface{}

• Type: interface{}

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

VpcId interface{}

• Type: interface{}

Property vpcId: The VPC id to create mongodb instance.

---

VSwitchId^Optional

VSwitchId interface{}

• Type: interface{}

Property vSwitchId: The vSwitch Id to create mongodb instance.

---

ZoneId^Optional

ZoneId interface{}

• Type: interface{}

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.

---