Skip to content

DatabaseProps

Properties for defining a Database.

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

Initializer

import ros_cdk_polardb
ros_cdk_polardb.DatabaseProps(
  character_set_name: typing.Union[str, IResolvable],
  db_cluster_id: typing.Union[str, IResolvable],
  db_name: typing.Union[str, IResolvable],
  account_name: typing.Union[str, IResolvable] = None,
  account_privilege: typing.Union[str, IResolvable] = None,
  collate: typing.Union[str, IResolvable] = None,
  ctype: typing.Union[str, IResolvable] = None,
  db_description: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
character_set_name typing.Union[str, ros_cdk_core.IResolvable] Property characterSetName: The character set of the database.
db_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a database is to be created.
db_name typing.Union[str, ros_cdk_core.IResolvable] Property dbName: The name of the database to be created.
account_name typing.Union[str, ros_cdk_core.IResolvable] Property accountName: The name of the database account to be used.
account_privilege typing.Union[str, ros_cdk_core.IResolvable] Property accountPrivilege: The permissions of the database account on the database.
collate typing.Union[str, ros_cdk_core.IResolvable] Property collate: A locale setting that specifies the collation for newly created databases.
ctype typing.Union[str, ros_cdk_core.IResolvable] Property ctype: A locale setting that specifies the character classification of the database.
db_description typing.Union[str, ros_cdk_core.IResolvable] Property dbDescription: The description of the database.

character_set_nameRequired

character_set_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property characterSetName: The character set of the database.

For more information, see Character sets.


db_cluster_idRequired

db_cluster_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


db_nameRequired

db_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


account_nameOptional

account_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


account_privilegeOptional

account_privilege: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

collate: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

ctype: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


db_descriptionOptional

db_description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.