Skip to content

DBClusterEndpoint

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

Initializers 

import com.aliyun.ros.cdk.polardb.DBClusterEndpoint;
DBClusterEndpoint.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbClusterId(java.lang.String)
    .dbClusterId(IResolvable)
//  .autoAddNewNodes(java.lang.String)
//  .autoAddNewNodes(IResolvable)
//  .endpointConfig(IResolvable)
//  .endpointConfig(EndpointConfigProperty)
//  .endpointType(java.lang.String)
//  .endpointType(IResolvable)
//  .nodes(java.util.List<java.lang.Object>)
//  .nodes(IResolvable)
//  .readWriteMode(java.lang.String)
//  .readWriteMode(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 custom connection point is to be created.
autoAddNewNodes java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property autoAddNewNodes: Specifies whether a newly added node is automatically added to this connection point.
endpointConfig com.aliyun.ros.cdk.core.IResolvable OR EndpointConfigProperty Property endpointConfig:.
endpointType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointType: The type of the cluster connection point.
nodes java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property nodes: The nodes to be added to this connection point to process read requests from this connection point.
readWriteMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property readWriteMode: The read\/write mode of the cluster connection point.

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 custom connection point is to be created.

autoAddNewNodesOptional

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

Property autoAddNewNodes: Specifies whether a newly added node is automatically added to this connection point.

Valid values: Enable, Disable. Default value: Disable.

endpointConfigOptional

Property endpointConfig:.

endpointTypeOptional

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

Property endpointType: The type of the cluster connection point.

Set this parameter to Custom.

nodesOptional

  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

Property nodes: The nodes to be added to this connection point to process read requests from this connection point.

Add at least two nodes. If you do not specify this parameter, all nodes of the cluster are added to this connection point by default.

readWriteModeOptional

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

Property readWriteMode: The read\/write mode of the cluster connection point.

Valid values: ReadWrite: receives and forwards read and write requests (automatic read-write splitting). ReadOnly: receives and forwards only read requests. Default value: ReadOnly.

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.DBClusterEndpoint;
DBClusterEndpoint.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.
attrAddresses com.aliyun.ros.cdk.core.IResolvable Attribute Addresses: The address items of the db cluster endpoint.
attrConnectionString com.aliyun.ros.cdk.core.IResolvable Attribute ConnectionString: The first connection string of the db cluster endpoint.
attrDbEndpointId com.aliyun.ros.cdk.core.IResolvable Attribute DBEndpointId: DB cluster endpoint ID.

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

attrAddressesRequired 

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

Attribute Addresses: The address items of the db cluster endpoint.

attrConnectionStringRequired 

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

Attribute ConnectionString: The first connection string of the db cluster endpoint.

attrDbEndpointIdRequired 

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

Attribute DBEndpointId: DB cluster endpoint ID.

E.g. pe-xxxxxxxx.