Skip to content

ShardingNetworkPrivateAddressProps

Properties for defining a ShardingNetworkPrivateAddress.

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

Initializer

import ros_cdk_mongodb
ros_cdk_mongodb.ShardingNetworkPrivateAddressProps(
  db_instance_id: typing.Union[str, IResolvable],
  node_id: typing.Union[str, IResolvable],
  account_name: typing.Union[str, IResolvable] = None,
  account_password: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
db_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceId: The ID of the Shard cluster instance.
node_id typing.Union[str, ros_cdk_core.IResolvable] Property nodeId: The ID of the Mongos node, Shard node, or ConfigServer node in the sharded cluster instance.
account_name typing.Union[str, ros_cdk_core.IResolvable] Property accountName: Account name.
account_password typing.Union[str, ros_cdk_core.IResolvable] Property accountPassword: Account password.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The ID of the zone to which the instance belongs.

db_instance_idRequired

db_instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbInstanceId: The ID of the Shard cluster instance.


node_idRequired

node_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


account_nameOptional

account_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

account_passwordOptional

account_password: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

zone_idOptional

zone_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.