Skip to content

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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dbClusterIdRequired

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

dbEndpointIdRequired

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

Property dbEndpointId: The ID of the cluster connection point.

connectionStringPrefixOptional

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

netTypeOptional

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

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

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

xRequired

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

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAddressRequired 

public IResolvable getAttrAddress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Address: The details of the endpoint address.

attrConnectionStringRequired 

public IResolvable getAttrConnectionString();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionString: The connection string of the endpoint address.