Skip to content

Account

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::Account, which is used to create a database account for a specified PolarDB cluster.

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)
    .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.
accountName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountName: The name of the database account.
accountPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountPassword: The password of the database account.
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 account is to be created.
accountDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountDescription: The description of the database account.
accountPrivilege java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountPrivilege: The permissions of the database account on the database.
accountType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accountType: The type of the database account.
dbName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbName: The name of the database whose access permissions are to be granted to the database account.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

accountNameRequired

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

Property accountName: The name of the database account.

The name must comply with the following rules:

  • It must start with a lowercase letter and consist of lowercase letters, digits, and underscores (_).
  • It can be up to 16 characters in length.

accountPasswordRequired

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

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

accountDescriptionOptional

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

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. Default value: ReadWrite. Separate multiple permissions with a comma (,).

accountTypeOptional

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

dbNameOptional

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

Property dbName: The name of the database whose access permissions are to be granted to the database account.

Separate multiple databases with a comma (,).

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.Account;
Account.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