Skip to content

DatabaseProps

Properties for defining a Database.

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

Initializer

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

Properties

Name Type 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.

characterSetNameRequired

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

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


dbNameRequired

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

public java.lang.Object getAccountName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


accountPrivilegeOptional

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


collateOptional

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

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

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