ShardingInstanceProps

Properties for defining a ShardingInstance.

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

Initializer

import { ShardingInstanceProps } from '@alicloud/ros-cdk-mongodb'
const shardingInstanceProps: ShardingInstanceProps = { ... }

Properties

Name	Type	Description
configServer	@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ConfigServerProperty[]	Property configServer:.
mongos	@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | MongosProperty[]	Property mongos:.
replicaSet	@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ReplicaSetProperty[]	Property replicaSet:.
accountPassword	string | @alicloud/ros-cdk-core.IResolvable	Property accountPassword: Root account password, can contain the letters, numbers or underscores the composition, length of 6~32 bit.
autoRenew	boolean | @alicloud/ros-cdk-core.IResolvable	Property autoRenew: Indicates whether automatic renewal is enabled for the instance.
chargeType	string | @alicloud/ros-cdk-core.IResolvable	Property chargeType: The billing method of the instance.values:PostPaid: Pay-As-You-Go.PrePaid: Subscription.Default value: PostPaid.
dbInstanceDescription	string | @alicloud/ros-cdk-core.IResolvable	Property dbInstanceDescription: Description of created database instance.
engineVersion	string | @alicloud/ros-cdk-core.IResolvable	Property engineVersion: Database instance version.
hiddenZoneId	string | @alicloud/ros-cdk-core.IResolvable	Property hiddenZoneId: Configure the zone where the hidden node resides to implement multi-availability zone deployment.
period	number | @alicloud/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	string | @alicloud/ros-cdk-core.IResolvable	Property protocolType: Protocol type.
resourceGroupId	string | @alicloud/ros-cdk-core.IResolvable	Property resourceGroupId: The ID of the resource group.
restoreTime	string | @alicloud/ros-cdk-core.IResolvable	Property restoreTime: The time to restore the cloned instance to.
secondaryZoneId	string | @alicloud/ros-cdk-core.IResolvable	Property secondaryZoneId: Configure the zone where the secondary node resides to implement multi-availability zone deployment.
securityIpArray	string | @alicloud/ros-cdk-core.IResolvable	Property securityIpArray: Security ips to add or remove.
srcDbInstanceId	string | @alicloud/ros-cdk-core.IResolvable	Property srcDbInstanceId: Create an instance of the backup set based on an instance.
storageEngine	string | @alicloud/ros-cdk-core.IResolvable	Property storageEngine: Database storage engine.Support WiredTiger, RocksDB, TerarkDB.
storageType	string | @alicloud/ros-cdk-core.IResolvable	Property storageType: The storage type of the instance.
tags	TagsProperty[]	Property tags: Tags to attach to instance.
tdeStatus	boolean | @alicloud/ros-cdk-core.IResolvable	Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).
vpcId	string | @alicloud/ros-cdk-core.IResolvable	Property vpcId: The VPC id to create mongodb instance.
vSwitchId	string | @alicloud/ros-cdk-core.IResolvable	Property vSwitchId: The vSwitch Id to create mongodb instance.
zoneId	string | @alicloud/ros-cdk-core.IResolvable	Property zoneId: On which zone to create the instance.

---

configServer^Required

public readonly configServer: IResolvable | IResolvable | ConfigServerProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ConfigServerProperty[]

Property configServer:.

---

mongos^Required

public readonly mongos: IResolvable | IResolvable | MongosProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | MongosProperty[]

Property mongos:.

---

replicaSet^Required

public readonly replicaSet: IResolvable | IResolvable | ReplicaSetProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ReplicaSetProperty[]

Property replicaSet:.

---

accountPassword^Optional

public readonly accountPassword: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

---

autoRenew^Optional

public readonly autoRenew: boolean | IResolvable;

• Type: boolean | @alicloud/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.

---

chargeType^Optional

public readonly chargeType: string | IResolvable;

• Type: string | @alicloud/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

public readonly dbInstanceDescription: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceDescription: Description of created database instance.

---

engineVersion^Optional

public readonly engineVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property engineVersion: Database instance version.

---

hiddenZoneId^Optional

public readonly hiddenZoneId: string | IResolvable;

• Type: string | @alicloud/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

public readonly period: number | IResolvable;

• Type: number | @alicloud/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^Optional

public readonly protocolType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property protocolType: Protocol type.

Valid value: mongodb or dynamodb.

---

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

---

restoreTime^Optional

public readonly restoreTime: string | IResolvable;

• Type: string | @alicloud/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

public readonly secondaryZoneId: string | IResolvable;

• Type: string | @alicloud/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

public readonly securityIpArray: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property securityIpArray: Security ips to add or remove.

---

srcDbInstanceId^Optional

public readonly srcDbInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

---

storageEngine^Optional

public readonly storageEngine: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

---

storageType^Optional

public readonly storageType: string | IResolvable;

• Type: string | @alicloud/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

public readonly 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

public readonly tdeStatus: boolean | IResolvable;

• Type: boolean | @alicloud/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

public readonly vpcId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The VPC id to create mongodb instance.

---

vSwitchId^Optional

public readonly vSwitchId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The vSwitch Id to create mongodb instance.

---

zoneId^Optional

public readonly zoneId: string | IResolvable;

• Type: string | @alicloud/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.

---