Skip to content

DatabaseProps

Properties for defining a Database.

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

Initializer

import ros_cdk_polardbx
ros_cdk_polardbx.DatabaseProps(
  accounts: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AccountsProperty]]],
  character_set_name: typing.Union[str, IResolvable],
  database_name: typing.Union[str, IResolvable],
  db_instance_id: typing.Union[str, IResolvable],
  database_description: typing.Union[str, IResolvable] = None,
  mode: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
accounts typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AccountsProperty]]] Property accounts: List of accounts.
character_set_name typing.Union[str, ros_cdk_core.IResolvable] Property characterSetName: Character set, which supports the following character sets: - utf8 * * - gbk - latin1 * * - *utf8mb4 * .
database_name typing.Union[str, ros_cdk_core.IResolvable] Property databaseName: The name of the database.
db_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceId: The ID of the instance.
database_description typing.Union[str, ros_cdk_core.IResolvable] Property databaseDescription: Database description information.
mode typing.Union[str, ros_cdk_core.IResolvable] Property mode: The mode selected when creating the database.

accountsRequired

accounts: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AccountsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AccountsProperty]]]

Property accounts: List of accounts.


character_set_nameRequired

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

Property characterSetName: Character set, which supports the following character sets: - utf8 * * - gbk - latin1 * * - *utf8mb4 * .


database_nameRequired

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

Property databaseName: The name of the database.


db_instance_idRequired

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

Property dbInstanceId: The ID of the instance.


database_descriptionOptional

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

Property databaseDescription: Database description information.


modeOptional

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

Property mode: The mode selected when creating the database.

The values are as follows:

  • auto: The database in this mode supports automatic partitioning, that is, you do not need to specify a partition key when creating a table;
  • drds: databases in this mode do not support automatic partitioning. When creating tables, you must use the dedicated database Shard syntax and specify the database shard key.