Skip to content

DrdsDB

This class encapsulates and extends the ROS resource type ALIYUN::DRDS::DrdsDB.

Initializers

import com.aliyun.ros.cdk.drds.DrdsDB;
DrdsDB.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .drdsInstanceId(java.lang.String)
    .drdsInstanceId(IResolvable)
//  .accountName(java.lang.String)
//  .accountName(IResolvable)
//  .dbInstanceIsCreating(java.lang.Boolean)
//  .dbInstanceIsCreating(IResolvable)
//  .dbInstType(java.lang.String)
//  .dbInstType(IResolvable)
//  .dbName(java.lang.String)
//  .dbName(IResolvable)
//  .encode(java.lang.String)
//  .encode(IResolvable)
//  .instDbName(IResolvable)
//  .instDbName(java.util.List<IResolvable)
//  .instDbName(InstDbNameProperty>)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .rdsInstance(IResolvable)
//  .rdsInstance(java.util.List<java.lang.String)
//  .rdsInstance(IResolvable>)
//  .type(java.lang.String)
//  .type(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.
drdsInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property drdsInstanceId: DRDS instance ID.
accountName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountName: In the vertical split scenario, an account name with access rights to the corresponding database on all RDSs.
dbInstanceIsCreating java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceIsCreating: Specifies whether the required ApsaraDB RDS for MySQL instance is being created.
dbInstType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstType: The type of the storage instances that are used by the PolarDB-X 1.0 database. Set the value to RDS.
dbName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbName: Database Name.
encode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property encode: The encoding method that is used by the database.
instDbName com.aliyun.ros.cdk.core.IResolvable OR java.util.ListInstDbNameProperty> Property instDbName: List of databases.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property password: The logon password of the database instance.
rdsInstance com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property rdsInstance: List of RDS instances.
type java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property type: Database Sharding method.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

drdsInstanceIdRequired

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

Property drdsInstanceId: DRDS instance ID.


accountNameOptional

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

Property accountName: In the vertical split scenario, an account name with access rights to the corresponding database on all RDSs.


dbInstanceIsCreatingOptional

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

Property dbInstanceIsCreating: Specifies whether the required ApsaraDB RDS for MySQL instance is being created.


dbInstTypeOptional

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

Property dbInstType: The type of the storage instances that are used by the PolarDB-X 1.0 database. Set the value to RDS.


dbNameOptional

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

Property dbName: Database Name.


encodeOptional

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

Property encode: The encoding method that is used by the database.


instDbNameOptional

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

Property instDbName: List of databases.


passwordOptional

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

Property password: The logon password of the database instance.


rdsInstanceOptional

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

Property rdsInstance: List of RDS instances.


typeOptional

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

Property type: Database Sharding method.

For more information, see scalability principle. Valid values: HORIZONTAL: indicates HORIZONTAL partitioning, which is commonly known as database and table sharding. VERTICAL: indicates VERTICAL partitioning.


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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

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)

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.drds.DrdsDB;
DrdsDB.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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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.
props DrdsDBProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


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

propsRequired

public DrdsDBProps getProps();