Database

• Implements: IDatabase

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

Initializers

import ros_cdk_gpdb
ros_cdk_gpdb.Database(
  scope: Construct,
  id: str,
  database_name: typing.Union[str, IResolvable],
  db_instance_id: typing.Union[str, IResolvable],
  owner: typing.Union[str, IResolvable],
  character_set_name: typing.Union[str, IResolvable] = None,
  collate: typing.Union[str, IResolvable] = None,
  ctype: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

database_name^Required

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

Property databaseName: Database Name.

db_instance_id^Required

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

Property dbInstanceId: Instance ID.

owner^Required

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

Property owner: Data Sheet owner.

character_set_name^Optional

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

Property characterSetName: Character set, default value is UTF8.

collate^Optional

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

Property collate: Database locale parameters, specifying string comparison\/collation.

ctype^Optional

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

Property ctype: Database locale parameters, specifying character classification\/case conversion rules.

description^Optional

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

Property description: Database Description.

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_gpdb
ros_cdk_gpdb.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_access_privilege^Required

attr_access_privilege: typing.Union[str, IResolvable]

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

Attribute AccessPrivilege: Permission Control Information.

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, default value is UTF8.

attr_collate^Required

attr_collate: typing.Union[str, IResolvable]

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

Attribute Collate: Database locale parameters, specifying string comparison/collation.

attr_conn_limit^Required

attr_conn_limit: typing.Union[str, IResolvable]

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

Attribute ConnLimit: Maximum connection limit,-1 means unrestricted.

attr_ctype^Required

attr_ctype: typing.Union[str, IResolvable]

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

Attribute Ctype: Database locale parameters, specifying character classification/case conversion rules.

attr_database_name^Required

attr_database_name: typing.Union[str, IResolvable]

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

Attribute DatabaseName: Database Name.

attr_db_instance_id^Required

attr_db_instance_id: typing.Union[str, IResolvable]

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

Attribute DBInstanceId: Instance ID.

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: Database Description.

attr_owner^Required

attr_owner: typing.Union[str, IResolvable]

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

Attribute Owner: Data Sheet owner.

attr_size^Required

attr_size: typing.Union[str, IResolvable]

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

Attribute Size: Database size.

attr_table_space^Required

attr_table_space: typing.Union[str, IResolvable]

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

Attribute TableSpace: Database table space.

props^Required

props: DatabaseProps

• Type: DatabaseProps