Database

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::Database, which is used to create a database in a PolarDB cluster.

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
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No 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.
enable_resource_property_constraint	bool	No description.

---

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 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_name^Optional

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

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

---

account_privilege^Optional

• 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. ReadIndex: has read and index permissions on the database. Default value: ReadWrite.

---

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.

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

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

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

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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

---