Account

• Implements: IAccount

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::AccountThe , which resource type creates accounts for PolarDB databases.

Initializers

import com.aliyun.ros.cdk.polardb.Account;
Account.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .accountName(java.lang.String)
    .accountName(IResolvable)
    .accountPassword(java.lang.String)
    .accountPassword(IResolvable)
    .dbClusterId(java.lang.String)
    .dbClusterId(IResolvable)
//  .accountDescription(java.lang.String)
//  .accountDescription(IResolvable)
//  .accountPrivilege(java.lang.String)
//  .accountPrivilege(IResolvable)
//  .accountType(java.lang.String)
//  .accountType(IResolvable)
//  .dbName(java.lang.String)
//  .dbName(IResolvable)
//  .privForAllDb(java.lang.String)
//  .privForAllDb(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

accountName^Required

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

Property accountName: The name of the database account.

The name must meet the following requirements:

• It must start with a lowercase letter and end with a letter or a digit.
• It can contain lowercase letters, digits, and underscores (_).
• It must be 1 to 16 characters in length.
• It cannot be a reserved keyword, such as root or admin.

accountPassword^Required

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

Property accountPassword: The password of the database account.

The password must comply with the following rules:

• It must consist of uppercase letters, lowercase letters, digits, and special characters.
• Special characters include exclamation points (!), number signs (#), dollar signs ($), percent signs (%), carets (^), ampersands (&), asterisks (*), parentheses (()), underscores (_), plus signs (+), hyphens (-), and equal signs (=).
• It must be 8 to 32 characters in length.

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 account is to be created.

accountDescription^Optional

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

Property accountDescription: The description of the database account.

The description must comply with the following rules:

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

accountPrivilege^Optional

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

Property accountPrivilege: The privilege level to grant on the specified databases.

Valid values:

• ReadWrite: read and write permissions
• ReadOnly: read-only permissions
• DMLOnly: DML permissions only
• DDLOnly: DDL permissions only
• ReadIndex: read-only and index permissions

• This parameter takes effect only when you specify the DBName parameter.
• If you specify multiple databases in DBName, you must specify a corresponding permission for each in AccountPrivilege, separated by commas. The AccountPrivilege string cannot exceed 900 characters. For example, to grant read and write permissions to database DB1 and read-only permissions to database DB2, set DBName to DB1,DB2 and set AccountPrivilege to ReadWrite,ReadOnly.
• This parameter applies only to standard accounts on PolarDB for MySQL clusters.

accountType^Optional

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

Property accountType: The type of the database account.

Valid values:

• Normal: standard account
• Super: privileged account Default value: Super. Currently, POLARDB for PostgreSQL and POLARDB compatible with Oracle do not support standard accounts. You can create only one privileged account for an ApsaraDB for POLARDB cluster.

dbName^Optional

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

Property dbName: The name of the database that the account can access.

To specify multiple databases, separate the database names with a comma (,).

This parameter applies only to standard accounts on PolarDB for MySQL clusters.

privForAllDb^Optional

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

Property privForAllDb: Whether to grant permissions to all libraries in the current cluster and any libraries that will be added in the future.

Valid values:

• 0 (default)): Not authorized.
• 1: Authorization.

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.Account;
Account.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 AccountProps getProps();

• Type: AccountProps