Database

• Implements: ros_cdk_dms.datasource.IDatabase

This class encapsulates and extends the ROS resource type DATASOURCE::DMS::Database.

Initializers

from ros_cdk_dms import datasource
datasource.Database(
  scope: Construct,
  id: str,
  host: typing.Union[str, IResolvable],
  port: typing.Union[typing.Union[int, float], IResolvable],
  schema_name: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  sid: typing.Union[str, IResolvable] = None,
  tid: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

host^Required

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

Property host: Database connection address.

port^Required

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

Property port: Database connection port.

schema_name^Required

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

Property schemaName: Database schema name.

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

sid^Optional

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

Property sid: Database SID.

tid^Optional

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

Property tid: The tenant ID.

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

from ros_cdk_dms import datasource
datasource.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_catalog_name^Required

attr_catalog_name: typing.Union[str, IResolvable]

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

Attribute CatalogName: Database catalog name.

attr_database_id^Required

attr_database_id: typing.Union[str, IResolvable]

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

Attribute DatabaseId: Database ID.

attr_dba_id^Required

attr_dba_id: typing.Union[str, IResolvable]

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

Attribute DbaId: Database administrator ID.

attr_dba_name^Required

attr_dba_name: typing.Union[str, IResolvable]

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

Attribute DbaName: Database administrator name.

attr_db_type^Required

attr_db_type: typing.Union[str, IResolvable]

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

Attribute DbType: Database type.

attr_encoding^Required

attr_encoding: typing.Union[str, IResolvable]

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

Attribute Encoding: Database encoding.

attr_env_type^Required

attr_env_type: typing.Union[str, IResolvable]

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

Attribute EnvType: Database environment type.

attr_host^Required

attr_host: typing.Union[str, IResolvable]

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

Attribute Host: Database connection address.

attr_instance_alias^Required

attr_instance_alias: typing.Union[str, IResolvable]

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

Attribute InstanceAlias: Database instance alias.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: Database instance ID.

attr_owner_id_list^Required

attr_owner_id_list: typing.Union[str, IResolvable]

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

Attribute OwnerIdList: Database owner ID list.

attr_owner_name_list^Required

attr_owner_name_list: typing.Union[str, IResolvable]

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

Attribute OwnerNameList: Database owner name list.

attr_port^Required

attr_port: typing.Union[str, IResolvable]

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

Attribute Port: Database connection port.

attr_schema_name^Required

attr_schema_name: typing.Union[str, IResolvable]

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

Attribute SchemaName: Database schema name.

attr_search_name^Required

attr_search_name: typing.Union[str, IResolvable]

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

Attribute SearchName: Database search name.

attr_sid^Required

attr_sid: typing.Union[str, IResolvable]

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

Attribute Sid: Database SID.

attr_state^Required

attr_state: typing.Union[str, IResolvable]

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

Attribute State: Database state.

props^Required

props: DatabaseProps

• Type: DatabaseProps