Database

• Implements: IDatabase

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

Initializers

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

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

accounts^Required

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

Property accounts: List of accounts.

character_set_name^Required

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

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

database_name^Required

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

Property databaseName: The name of the database.

db_instance_id^Required

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

Property dbInstanceId: The ID of the instance.

database_description^Optional

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

Property databaseDescription: Database description information.

mode^Optional

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

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_polardbx
ros_cdk_polardbx.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

attr_accounts^Required

attr_accounts: typing.Union[str, IResolvable]

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

Attribute Accounts: List of accounts.

attr_character_set_name^Required

attr_character_set_name: typing.Union[str, IResolvable]

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

Attribute CharacterSetName: Character set, which supports the following character sets:.

attr_database_description^Required

attr_database_description: typing.Union[str, IResolvable]

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

Attribute DatabaseDescription: Database description information.

attr_database_name^Required

attr_database_name: typing.Union[str, IResolvable]

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

Attribute DatabaseName: The name of the database.

attr_db_instance_id^Required

attr_db_instance_id: typing.Union[str, IResolvable]

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

Attribute DBInstanceId: The ID of the instance.

props^Required

props: DatabaseProps

• Type: DatabaseProps