Skip to content

DatabaseProps

Properties for defining a Database.

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

Initializer 

import { DatabaseProps } from '@alicloud/ros-cdk-polardb'
const databaseProps: DatabaseProps = { ... }

Properties

Name Type Description
characterSetName string | @alicloud/ros-cdk-core.IResolvable Property characterSetName: The character set of the database.
dbClusterId string | @alicloud/ros-cdk-core.IResolvable Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a database is to be created.
dbName string | @alicloud/ros-cdk-core.IResolvable Property dbName: The name of the database to be created.
accountName string | @alicloud/ros-cdk-core.IResolvable Property accountName: The name of the database account to be used.
accountPrivilege string | @alicloud/ros-cdk-core.IResolvable Property accountPrivilege: The permissions of the database account on the database.
collate string | @alicloud/ros-cdk-core.IResolvable Property collate: A locale setting that specifies the collation for newly created databases.
ctype string | @alicloud/ros-cdk-core.IResolvable Property ctype: A locale setting that specifies the character classification of the database.
dbDescription string | @alicloud/ros-cdk-core.IResolvable Property dbDescription: The description of the database.

characterSetNameRequired 

public readonly characterSetName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property characterSetName: The character set of the database.

For more information, see Character sets.

dbClusterIdRequired 

public readonly dbClusterId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a database is to be created.

dbNameRequired 

public readonly dbName: string | IResolvable;
  • Type: string | @alicloud/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 readonly accountName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

accountPrivilegeOptional 

public readonly accountPrivilege: string | IResolvable;
  • Type: string | @alicloud/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. ReadIndex: has read and index permissions on the database. Default value: ReadWrite.

collateOptional 

public readonly collate: string | IResolvable;
  • Type: string | @alicloud/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 readonly ctype: string | IResolvable;
  • Type: string | @alicloud/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 readonly dbDescription: string | IResolvable;
  • Type: string | @alicloud/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.