Skip to content

Database

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

Initializers 

import com.aliyun.ros.cdk.polardb.Database;
Database.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .characterSetName(java.lang.String)
    .characterSetName(IResolvable)
    .dbClusterId(java.lang.String)
    .dbClusterId(IResolvable)
    .dbName(java.lang.String)
    .dbName(IResolvable)
//  .accountName(java.lang.String)
//  .accountName(IResolvable)
//  .accountPrivilege(java.lang.String)
//  .accountPrivilege(IResolvable)
//  .collate(java.lang.String)
//  .collate(IResolvable)
//  .ctype(java.lang.String)
//  .ctype(IResolvable)
//  .dbDescription(java.lang.String)
//  .dbDescription(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.
characterSetName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property characterSetName: The character set of the database.
dbClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a database is to be created.
dbName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbName: The name of the database to be created.
accountName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountName: The name of the database account to be used.
accountPrivilege java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountPrivilege: The permissions of the database account on the database.
collate java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property collate: A locale setting that specifies the collation for newly created databases.
ctype java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ctype: A locale setting that specifies the character classification of the database.
dbDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbDescription: The description of the database.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

characterSetNameRequired

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

Property characterSetName: The character set of the database.

For more information, see Character sets.

dbClusterIdRequired

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

Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a database is to be created.

dbNameRequired

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

Property dbName: The name of the database to be created.

The name must comply with the following rules: It must start with a lowercase letter and consist of lowercase letters, digits, hyphens (-), and underscores (_). It must end with a letter or a digit. It can be up to 64 characters in length.

accountNameOptional

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

Property accountName: The name of the database account to be used.

accountPrivilegeOptional

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

Property accountPrivilege: The permissions of the database account on the database.

Valid values: ReadWrite: has read and write permissions on the database. ReadOnly: has the read-only permission on the database. DMLOnly: runs only data manipulation language (DML) statements. DDLOnly: runs only data definition language (DDL) statements. ReadIndex: has read and index permissions on the database. Default value: ReadWrite.

collateOptional

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

Property collate: A locale setting that specifies the collation for newly created databases.

The locale must be compatible with the character set set by the CharacterSetName parameter.When the cluster is PolarDB PostgreSQL (compatible with Oracle) or PolarDB PostgreSQL, this parameter is required; when the cluster is PolarDB MySQL, this parameter is not supported.

ctypeOptional

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

Property ctype: A locale setting that specifies the character classification of the database.

The locale must be compatible with the character set set by the CharacterSetName parameter. It is consistent with the incoming information of Collate. When the cluster is PolarDB PostgreSQL (compatible with Oracle) or PolarDB PostgreSQL, this parameter is required; when the cluster is PolarDB MySQL, this parameter is optional.

dbDescriptionOptional

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

Property dbDescription: The description of the database.

Valid values: It cannot start with http:// or https://. It must be 2 to 256 characters in length.

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

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