ShardingNetworkPrivateAddress

• Implements: IShardingNetworkPrivateAddress

This class encapsulates and extends the ROS resource type ALIYUN::MONGODB::ShardingNetworkPrivateAddress.

Initializers

import ros_cdk_mongodb
ros_cdk_mongodb.ShardingNetworkPrivateAddress(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

db_instance_id^Required

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

Property dbInstanceId: The ID of the Shard cluster instance.

node_id^Required

• 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_name^Optional

• 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_password^Optional

• 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_id^Optional

• 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_mongodb
ros_cdk_mongodb.ShardingNetworkPrivateAddress.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_compatible_connections^Required

attr_compatible_connections: typing.Union[str, IResolvable]

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

Attribute CompatibleConnections: The list of connection addresses of the DynamoDB protocol instance.

attr_network_addresses^Required

attr_network_addresses: typing.Union[str, IResolvable]

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

Attribute NetworkAddresses: A list of connection addresses of an instance of the MongoDB protocol type.

props^Required

props: ShardingNetworkPrivateAddressProps

• Type: ShardingNetworkPrivateAddressProps