Skip to content

Connection

This class encapsulates and extends the ROS resource type ALIYUN::RDS::Connection, which is used to apply for a public endpoint.

Initializers

import com.aliyun.ros.cdk.rds.Connection;
Connection.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbInstanceId(java.lang.String)
    .dbInstanceId(IResolvable)
    .port(java.lang.Number)
    .port(IResolvable)
//  .babelfishPort(java.lang.String)
//  .babelfishPort(IResolvable)
//  .connectionStringPrefix(java.lang.String)
//  .connectionStringPrefix(IResolvable)
//  .generalGroupName(java.lang.String)
//  .generalGroupName(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.
dbInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceId: RDS instance ID.
port java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property port: The port of the database service.
babelfishPort java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property babelfishPort: The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.
connectionStringPrefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property connectionStringPrefix: The prefix of the endpoint.
generalGroupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property generalGroupName: The name of the dedicated cluster to which the instance belongs.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dbInstanceIdRequired

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

Property dbInstanceId: RDS instance ID.


portRequired

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

Property port: The port of the database service.


babelfishPortOptional

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

Property babelfishPort: The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.

Note This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to Babelfish.


connectionStringPrefixOptional

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

Property connectionStringPrefix: The prefix of the endpoint.

Only the prefix of the CurrentConnectionString parameter value can be modified. The prefix must be 5 to 40 characters in length and can contain letters, digits, and hyphens (-).


generalGroupNameOptional

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

Property generalGroupName: The name of the dedicated cluster to which the instance belongs.

This parameter takes effect only when the instance runs MySQL on RDS Standard Edition and is created in a dedicated cluster.


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.rds.Connection;
Connection.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.
attrBabelfishPort com.aliyun.ros.cdk.core.IResolvable Attribute BabelfishPort: The name of the dedicated cluster to which the instance belongs.
attrConnectionString com.aliyun.ros.cdk.core.IResolvable Attribute ConnectionString: Connection string.
attrDbInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute DBInstanceId: RDS instance ID.
attrPort com.aliyun.ros.cdk.core.IResolvable Attribute Port: The port of the database service.

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

attrBabelfishPortRequired

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

Attribute BabelfishPort: The name of the dedicated cluster to which the instance belongs.


attrConnectionStringRequired

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

Attribute ConnectionString: Connection string.


attrDbInstanceIdRequired

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

Attribute DBInstanceId: RDS instance ID.


attrPortRequired

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

Attribute Port: The port of the database service.