ShardingNetworkPrivateAddressProps
Properties for defining a ShardingNetworkPrivateAddress.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-mongodb-shardingnetworkprivateaddress
Initializer
import { ShardingNetworkPrivateAddressProps } from '@alicloud/ros-cdk-mongodb'
const shardingNetworkPrivateAddressProps: ShardingNetworkPrivateAddressProps = { ... }
Properties
| Name | Type | Description |
|---|---|---|
dbInstanceId | string | @alicloud/ros-cdk-core.IResolvable | Property dbInstanceId: The ID of the Shard cluster instance. |
nodeId | string | @alicloud/ros-cdk-core.IResolvable | Property nodeId: The ID of the Mongos node, Shard node, or ConfigServer node in the sharded cluster instance. |
accountName | string | @alicloud/ros-cdk-core.IResolvable | Property accountName: Account name. |
accountPassword | string | @alicloud/ros-cdk-core.IResolvable | Property accountPassword: Account password. |
zoneId | string | @alicloud/ros-cdk-core.IResolvable | Property zoneId: The ID of the zone to which the instance belongs. |
dbInstanceIdRequired
public readonly dbInstanceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property dbInstanceId: The ID of the Shard cluster instance.
nodeIdRequired
public readonly nodeId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property nodeId: The ID of the Mongos node, Shard node, or ConfigServer node in the sharded cluster instance.
You can call the [DescribeDBInstanceAttribute] interface to query the Mongos, Shard, and ConfigServer node ID.
accountNameOptional
public readonly accountName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property accountName: Account name.
- starts with a lowercase letter, has 4 to 16 digits in length, and consists of lowercase letters, numbers, or underscores.
- Only when you apply for the Shard\/ConfigServer address for the first time, you need to set the account name and password. That is, all Shard nodes and ConfigServer nodes will use the account and password set when applying for the address for the first time.
- The permissions of this account are fixed to read-only.
accountPasswordOptional
public readonly accountPassword: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property accountPassword: Account password.
The password consists of at least three of uppercase letters, lowercase letters, numbers, and special characters. The special character is '! #$%^& *()_+-=' - The password length is 8-32 bits.
zoneIdOptional
public readonly zoneId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property zoneId: The ID of the zone to which the instance belongs.
You can call the [describeddinstanceattribute] operation to query the zone ID of an instance.