DBClusterEndpointAddress

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::DBClusterEndpointAddress, which is used to create a public endpoint for an Apsara PolarDB cluster.

The public endpoint can be a primary endpoint, the default cluster endpoint, or a custom cluster endpoint.

Initializers

import com.aliyun.ros.cdk.polardb.DBClusterEndpointAddress;
DBClusterEndpointAddress.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbClusterId(java.lang.String)
    .dbClusterId(IResolvable)
    .dbEndpointId(java.lang.String)
    .dbEndpointId(IResolvable)
//  .connectionStringPrefix(java.lang.String)
//  .connectionStringPrefix(IResolvable)
//  .netType(java.lang.String)
//  .netType(IResolvable)
    .build();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
dbClusterId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a public connection point is to be created.
dbEndpointId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property dbEndpointId: The ID of the cluster connection point.
connectionStringPrefix	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property connectionStringPrefix: The prefix of the connection string.
netType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property netType: The network type of the connection string.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

dbClusterId^Required

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

Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a public connection point is to be created.

---

dbEndpointId^Required

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

Property dbEndpointId: The ID of the cluster connection point.

---

connectionStringPrefix^Optional

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

Property connectionStringPrefix: The prefix of the connection string.

The prefix must comply with the following rules: It must start with a letter and consist of lowercase letters, digits, and hyphens(-), cannot end with a dash. The length is 6~30 characters.

---

netType^Optional

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

Property netType: The network type of the connection string.

If set to Public, ROS will create, modify and delete Public address for you. If set to Private, ROS will only modify Private address for you. Default to Public.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

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

---

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

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import com.aliyun.ros.cdk.polardb.DBClusterEndpointAddress;
DBClusterEndpointAddress.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrAddress	com.aliyun.ros.cdk.core.IResolvable	Attribute Address: The details of the endpoint address.
attrConnectionString	com.aliyun.ros.cdk.core.IResolvable	Attribute ConnectionString: The connection string of the endpoint address.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

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

---

attrAddress^Required

public IResolvable getAttrAddress();

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

Attribute Address: The details of the endpoint address.

---

attrConnectionString^Required

public IResolvable getAttrConnectionString();

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

Attribute ConnectionString: The connection string of the endpoint address.

---