Skip to content

Database

This class encapsulates and extends the ROS resource type ALIYUN::PolarDBX::Database, which is used to create a database.

Initializers 

import com.aliyun.ros.cdk.polardbx.Database;
Database.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .accounts(IResolvable)
    .accounts(java.util.List<IResolvable)
    .accounts(AccountsProperty>)
    .characterSetName(java.lang.String)
    .characterSetName(IResolvable)
    .databaseName(java.lang.String)
    .databaseName(IResolvable)
    .dbInstanceId(java.lang.String)
    .dbInstanceId(IResolvable)
//  .databaseDescription(java.lang.String)
//  .databaseDescription(IResolvable)
//  .mode(java.lang.String)
//  .mode(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.
accounts com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAccountsProperty> Property accounts: List of accounts.
characterSetName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property characterSetName: Character set, which supports the following character sets: - utf8 * * - gbk - latin1 * * - *utf8mb4 * .
databaseName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property databaseName: The name of the database.
dbInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceId: The ID of the instance.
databaseDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property databaseDescription: Database description information.
mode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property mode: The mode selected when creating the database.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

accountsRequired

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

Property accounts: List of accounts.

characterSetNameRequired

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

Property characterSetName: Character set, which supports the following character sets: - utf8 * * - gbk - latin1 * * - *utf8mb4 * .

databaseNameRequired

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

Property databaseName: The name of the database.

dbInstanceIdRequired

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

Property dbInstanceId: The ID of the instance.

databaseDescriptionOptional

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

Property databaseDescription: Database description information.

modeOptional

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

Property mode: The mode selected when creating the database.

The values are as follows:

  • auto: The database in this mode supports automatic partitioning, that is, you do not need to specify a partition key when creating a table;
  • drds: databases in this mode do not support automatic partitioning. When creating tables, you must use the dedicated database Shard syntax and specify the database shard key.

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.polardbx.Database;
Database.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.
attrAccounts com.aliyun.ros.cdk.core.IResolvable Attribute Accounts: List of accounts.
attrCharacterSetName com.aliyun.ros.cdk.core.IResolvable Attribute CharacterSetName: Character set, which supports the following character sets:.
attrDatabaseDescription com.aliyun.ros.cdk.core.IResolvable Attribute DatabaseDescription: Database description information.
attrDatabaseName com.aliyun.ros.cdk.core.IResolvable Attribute DatabaseName: The name of the database.
attrDbInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute DBInstanceId: The ID of the instance.

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

attrAccountsRequired 

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

Attribute Accounts: List of accounts.

attrCharacterSetNameRequired 

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

Attribute CharacterSetName: Character set, which supports the following character sets:.

attrDatabaseDescriptionRequired 

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

Attribute DatabaseDescription: Database description information.

attrDatabaseNameRequired 

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

Attribute DatabaseName: The name of the database.

attrDbInstanceIdRequired 

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

Attribute DBInstanceId: The ID of the instance.