Database

• Implements: IDatabase

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::Database.

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();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

characterSetName^Required

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

dbClusterId^Required

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

dbName^Required

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

Property dbName: The name of the database.

The name must meet the following requirements:

• The name can contain lowercase letters, digits, hyphens (-), and underscores (_).
• The name must start with a lowercase letter and end with a lowercase letter or a digit. The name must be 1 to 64 characters in length.

Do not use reserved words as database names, such as test or mysql.

accountName^Optional

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

Property accountName: The name of the account that is authorized to access the database.

You can call the DescribeAccounts operation to query account information.

• You can specify only a standard account. By default, privileged accounts have all permissions on all databases. You do not need to grant privileged accounts the permissions to access the database.
• This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.

accountPrivilege^Optional

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

Property accountPrivilege: The permissions that are granted to the account.

Valid values:

• ReadWrite: read and write permissions.
• ReadOnly: read-only permissions.
• DMLOnly: permissions only to execute DML statements on the database.
• DDLOnly: permissions only to execute DDL statements on the database.
• ReadIndex: read-only and index permissions. The default value is ReadWrite.

• This parameter is valid only when the AccountName parameter is specified.
• For a PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL cluster, this parameter is optional. If AccountName is specified, it is the account of the database owner.
• For a PolarDB for MySQL cluster, this parameter is optional.

collate^Optional

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

ctype^Optional

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

dbDescription^Optional

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

Property dbDescription: The description of the database.

The description must meet the following requirements:

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

This parameter is required for a PolarDB for Oracle or PolarDB for PostgreSQL cluster. This parameter is optional for a PolarDB for MySQL cluster.

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

props^Required

public DatabaseProps getProps();

• Type: DatabaseProps