DBInstance

• Implements: IDBInstance

This class encapsulates and extends the ROS resource type ALIYUN::SELECTDB::DBInstance, which is used to create an ApsaraDB for SelectDB instance.

Initializers

import ros_cdk_selectdb
ros_cdk_selectdb.DBInstance(
  scope: Construct,
  id: str,
  cache_size: typing.Union[typing.Union[int, float], IResolvable],
  charge_type: typing.Union[str, IResolvable],
  db_instance_class: typing.Union[str, IResolvable],
  engine_version: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  account_password: typing.Union[str, IResolvable] = None,
  connection_string: typing.Union[str, IResolvable] = None,
  db_instance_description: typing.Union[str, IResolvable] = None,
  engine: typing.Union[str, IResolvable] = None,
  period: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_ip_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  tags: typing.List[TagsProperty] = None,
  used_time: 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

cache_size^Required

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

Property cacheSize: Reserve cache size.

charge_type^Required

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

Property chargeType: The paid type of instance.Value: Postpaid: Postpaid (pay per quantity). Prepaid: Prepaid (year and monthly).

db_instance_class^Required

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

Property dbInstanceClass: The class of the DB instance.

Call DescribeAllDBInstanceClass API to check the latest class list

engine_version^Required

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

Property engineVersion: The database version.

The default value is 4.1. Valid values:

• 4.0
• 4.1

vpc_id^Required

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

Property vpcId: VPC id.

v_switch_id^Required

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

Property vSwitchId: Switch ID.

zone_id^Required

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

Property zoneId: Availability Zone ID.

account_password^Optional

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

Property accountPassword: The password of the instance login account, the current account name of selectdb can only be admin.

connection_string^Optional

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

Property connectionString: Database connection address.

db_instance_description^Optional

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

Property dbInstanceDescription: Example Notes Information.

engine^Optional

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

Property engine: Database type, default value is selectdb.

period^Optional

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

Property period: Specify the prepaid cluster as annual or monthly type.Value description: Year: Year-end type. Month: Month type. Note This parameter takes effect and is required only if ChargeType is Prepaid.

resource_group_id^Optional

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

Property resourceGroupId: Resource Group ID.

security_ip_list^Optional

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

Property securityIpList: The default IP whitelist of the instance.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: The list of tags in the form of key\/value pairs.

You can define a maximum of 20 tags.

used_time^Optional

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

Property usedTime: The subscription duration of the subscription instance.

Valid values:

• If Period is set to Year, valid values are 1, 2, 3, 4, and 5.
• If Period is set to Month, valid values are integers from 1 to 12.

This parameter is required and takes effect only when ChargeType is set to Prepaid.

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_selectdb
ros_cdk_selectdb.DBInstance.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_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_vpc_connection_string^Required

attr_vpc_connection_string: typing.Union[str, IResolvable]

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

Attribute VpcConnectionString: The VPC connection string of the selectdb instance.

props^Required

props: DBInstanceProps

• Type: DBInstanceProps