Skip to content

AccountProps

Properties for defining a Account.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-account

Initializer

import com.aliyun.ros.cdk.polardb.AccountProps;
AccountProps.builder()
    .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();

Properties

Name Type 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 privilege level to grant on the specified databases.
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 that the account can access.
privForAllDb 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.

accountNameRequired

public java.lang.Object getAccountName();
  • 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.

accountPasswordRequired

public java.lang.Object getAccountPassword();
  • 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

public java.lang.Object getDbClusterId();
  • 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

public java.lang.Object getAccountDescription();
  • 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

public java.lang.Object getAccountPrivilege();
  • 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.

accountTypeOptional

public java.lang.Object getAccountType();
  • 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

public java.lang.Object getDbName();
  • 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.


privForAllDbOptional

public java.lang.Object getPrivForAllDb();
  • 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.