Skip to content

RdsExternalStore

This class encapsulates and extends the ROS resource type ALIYUN::SLS::RdsExternalStore.

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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
db 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property externalStoreName: The name of the external store.
host 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 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 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property project: The name of the project.
region java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property region: The region where the ApsaraDB RDS for MySQL instance resides.
storeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storeType: The storage type.
table 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 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 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The id of the RDS instance.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dbRequired

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


externalStoreNameRequired

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


hostRequired

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


passwordRequired

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


portRequired

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


projectRequired

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

Property project: The name of the project.


regionRequired

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


storeTypeRequired

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


tableRequired

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


usernameRequired

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


vpcIdRequired

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


instanceIdOptional

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

Property instanceId: The id of the RDS instance.


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.sls.RdsExternalStore;
RdsExternalStore.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.
attrExternalStoreName com.aliyun.ros.cdk.core.IResolvable Attribute ExternalStoreName: The name of the external store.
attrProject com.aliyun.ros.cdk.core.IResolvable Attribute Project: The name of the project to which the external store belongs.

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

attrExternalStoreNameRequired

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

Attribute ExternalStoreName: The name of the external store.


attrProjectRequired

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

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