Skip to content

Connection

This class encapsulates and extends the ROS resource type ALIYUN::REDIS::Connection, which is used to apply for a public endpoint for an ApsaraDB for Redis instance.

Initializers 

import com.aliyun.ros.cdk.redis.Connection;
Connection.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .connectionStringPrefix(java.lang.String)
    .connectionStringPrefix(IResolvable)
    .connectionType(java.lang.String)
    .connectionType(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .port(java.lang.Number)
    .port(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.
connectionStringPrefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property connectionStringPrefix: The prefix of the public endpoint.
connectionType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property connectionType: Allowed values: - Public: Public address.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: Instance ID (globally unique).
port java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property port: The service port number of the ApsaraDB for Redis instance.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

connectionStringPrefixRequired

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

Property connectionStringPrefix: The prefix of the public endpoint.

The prefix must be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.

connectionTypeRequired

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

Property connectionType: Allowed values: - Public: Public address.

  • Direct: Direct connection address. The instance is a cluster instance. You can apply for a direct connection endpoint as required.

instanceIdRequired

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

Property instanceId: Instance ID (globally unique).

portRequired

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

Property port: The service port number of the ApsaraDB for Redis instance.

Valid values: 1024 to 65535.

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.redis.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.
attrConnectionString com.aliyun.ros.cdk.core.IResolvable Attribute ConnectionString: The allocated connection string.

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

attrConnectionStringRequired 

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

Attribute ConnectionString: The allocated connection string.