RdsExternalStore

• Implements: IRdsExternalStore

This class encapsulates and extends the ROS resource type ALIYUN::SLS::RdsExternalStore, which is used to create an ApsaraDB RDS for MySQL external store.

Initializers

import com.aliyun.ros.cdk.sls.RdsExternalStore;
RdsExternalStore.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .db(java.lang.String)
    .db(IResolvable)
    .externalStoreName(java.lang.String)
    .externalStoreName(IResolvable)
    .host(java.lang.String)
    .host(IResolvable)
    .password(java.lang.String)
    .password(IResolvable)
    .port(java.lang.Number)
    .port(IResolvable)
    .project(java.lang.String)
    .project(IResolvable)
    .region(java.lang.String)
    .region(IResolvable)
    .storeType(java.lang.String)
    .storeType(IResolvable)
    .table(java.lang.String)
    .table(IResolvable)
    .username(java.lang.String)
    .username(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
//  .instanceId(java.lang.String)
//  .instanceId(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

db^Required

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

Property db: The name of the database in the ApsaraDB RDS for MySQL instance.

externalStoreName^Required

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

Property externalStoreName: The name of the external store.

The name must be unique in a project and different from Logstore.

host^Required

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

Property host: The internal or public endpoint of the ApsaraDB RDS for MySQL instance.

password^Required

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

Property password: The password that is used to log on to the ApsaraDB RDS for MySQL instance.

port^Required

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

Property port: The internal or public port of the ApsaraDB RDS for MySQL instance.

project^Required

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

Property project: The name of the project.

region^Required

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

Property region: The region where the ApsaraDB RDS for MySQL instance resides.

Valid values: cn-qingdao, cn-beijing, cn-hangzhou.

storeType^Required

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

Property storeType: The storage type.

Set the value to rds-vpc, which indicates an ApsaraDB RDS for MySQL database in a virtual private cloud (VPC).

table^Required

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

Property table: The name of the database table in the ApsaraDB RDS for MySQL instance.

username^Required

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

Property username: The username that is used to log on to the ApsaraDB RDS for MySQL instance.

vpcId^Required

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

Property vpcId: The ID of the VPC to which the ApsaraDB RDS for MySQL instance belongs.

instanceId^Optional

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

Property instanceId: The id of the RDS instance.

Methods

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

isConstruct

import com.aliyun.ros.cdk.sls.RdsExternalStore;
RdsExternalStore.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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

attrExternalStoreName^Required

public java.lang.Object getAttrExternalStoreName();

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

Attribute ExternalStoreName: The name of the external store.

attrProject^Required

public java.lang.Object getAttrProject();

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

Attribute Project: The name of the project to which the external store belongs.

props^Required

public RdsExternalStoreProps getProps();

• Type: RdsExternalStoreProps