ShardingNetworkPrivateAddress

• Implements: IShardingNetworkPrivateAddress

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

Initializers

import com.aliyun.ros.cdk.mongodb.ShardingNetworkPrivateAddress;
ShardingNetworkPrivateAddress.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbInstanceId(java.lang.String)
    .dbInstanceId(IResolvable)
    .nodeId(java.lang.String)
    .nodeId(IResolvable)
//  .accountName(java.lang.String)
//  .accountName(IResolvable)
//  .accountPassword(java.lang.String)
//  .accountPassword(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

dbInstanceId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceId: The ID of the Shard cluster instance.

nodeId^Required

• Type: java.lang.String OR com.aliyun.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.

accountName^Optional

• Type: java.lang.String OR com.aliyun.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.

accountPassword^Optional

• Type: java.lang.String OR com.aliyun.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.

zoneId^Optional

• Type: java.lang.String OR com.aliyun.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.mongodb.ShardingNetworkPrivateAddress;
ShardingNetworkPrivateAddress.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrCompatibleConnections^Required

public java.lang.Object getAttrCompatibleConnections();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrNetworkAddresses^Required

public java.lang.Object getAttrNetworkAddresses();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public ShardingNetworkPrivateAddressProps getProps();

• Type: ShardingNetworkPrivateAddressProps