Database

• Implements: IDatabase

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::Database.

Initializers

import ros_cdk_polardb
ros_cdk_polardb.Database(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

character_set_name^Required

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

Property characterSetName: The character set of the database.

For more information, see Character sets.

db_cluster_id^Required

• 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_name^Required

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

Property dbName: The name of the database.

The name must meet the following requirements:

• The name can contain lowercase letters, digits, hyphens (-), and underscores (_).
• The name must start with a lowercase letter and end with a lowercase letter or a digit. The name must be 1 to 64 characters in length.

Do not use reserved words as database names, such as test or mysql.

account_name^Optional

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

Property accountName: The name of the account that is authorized to access the database.

You can call the DescribeAccounts operation to query account information.

• You can specify only a standard account. By default, privileged accounts have all permissions on all databases. You do not need to grant privileged accounts the permissions to access the database.
• This parameter is required for PolarDB for PostgreSQL (Compatible with Oracle) clusters or PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.

account_privilege^Optional

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

Property accountPrivilege: The permissions that are granted to the account.

Valid values:

• ReadWrite: read and write permissions.
• ReadOnly: read-only permissions.
• DMLOnly: permissions only to execute DML statements on the database.
• DDLOnly: permissions only to execute DDL statements on the database.
• ReadIndex: read-only and index permissions. The default value is ReadWrite.

• This parameter is valid only when the AccountName parameter is specified.
• For a PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL cluster, this parameter is optional. If AccountName is specified, it is the account of the database owner.
• For a PolarDB for MySQL cluster, this parameter is optional.

collate^Optional

• 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.

ctype^Optional

• 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_description^Optional

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

Property dbDescription: The description of the database.

The description must meet the following requirements:

• It cannot start with http:\/\/ or https:\/\/.
• It must be 2 to 256 characters in length.

This parameter is required for a PolarDB for Oracle or PolarDB for PostgreSQL cluster. This parameter is optional for a PolarDB for MySQL cluster.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_polardb
ros_cdk_polardb.Database.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

props^Required

props: DatabaseProps

• Type: DatabaseProps