DBCluster

• Implements: IDBCluster

This class encapsulates and extends the ROS resource type ALIYUN::ADBLake::DBCluster, which type is used to create an AnalyticDB for MySQL Data Lakehouse Edition cluster.

Initializers

import ros_cdk_adblake
ros_cdk_adblake.DBCluster(
  scope: Construct,
  id: str,
  db_cluster_version: typing.Union[str, IResolvable],
  pay_type: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  backup_set_id: typing.Union[str, IResolvable] = None,
  clone_source_region_id: typing.Union[str, IResolvable] = None,
  compute_resource: typing.Union[str, IResolvable] = None,
  db_cluster_description: typing.Union[str, IResolvable] = None,
  db_cluster_network_type: typing.Union[str, IResolvable] = None,
  disk_encryption: typing.Union[bool, IResolvable] = None,
  enable_default_resource_pool: typing.Union[bool, IResolvable] = None,
  kms_id: typing.Union[str, IResolvable] = None,
  period: typing.Union[str, IResolvable] = None,
  period_type: typing.Union[str, IResolvable] = None,
  product_form: typing.Union[str, IResolvable] = None,
  product_version: typing.Union[str, IResolvable] = None,
  reserved_node_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  reserved_node_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  restore_to_time: typing.Union[str, IResolvable] = None,
  restore_type: typing.Union[str, IResolvable] = None,
  secondary_v_switch_id: typing.Union[str, IResolvable] = None,
  secondary_zone_id: typing.Union[str, IResolvable] = None,
  source_db_cluster_id: typing.Union[str, IResolvable] = None,
  storage_resource: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

db_cluster_version^Required

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

Property dbClusterVersion: The version of the cluster.

Set the value to 5.0.

pay_type^Required

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

Property payType: The billing method of the cluster.

Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.

vpc_id^Required

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

Property vpcId: The virtual private cloud (VPC) ID of the cluster.

v_switch_id^Required

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

Property vSwitchId: The vSwitch ID of the cluster.

zone_id^Required

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

Property zoneId: The zone ID.

Note You can call the DescribeRegions operation to query the most recent zone list.

backup_set_id^Optional

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

Property backupSetId: The ID of the backup set that you want to use to restore data.

Note You can call the DescribeBackups operation to query the backup sets of the cluster.

clone_source_region_id^Optional

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

Property cloneSourceRegionId: The ID of the source region where the cluster is located.

compute_resource^Optional

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

Property computeResource: The amount of reserved computing resources.

Unit: ACUs. Valid values: 0ACU to 4096ACU. The value must be in increments of 16 ACUs. Each ACU is equivalent to 1 core and 4 GB memory. Note This parameter must be specified with a unit.

db_cluster_description^Optional

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

Property dbClusterDescription: The description of the cluster.

The description cannot start with http:// or https://. The description must be 2 to 256 characters in length

db_cluster_network_type^Optional

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

Property dbClusterNetworkType: The network type of the cluster.

Valid values: VPC

disk_encryption^Optional

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

Property diskEncryption: Specifies whether to encrypt the disk.

Valid values: true false (default)

enable_default_resource_pool^Optional

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

Property enableDefaultResourcePool: Specifies whether to allocate all reserved computing resources to the user_default resource group.

Valid values: true (default) false

kms_id^Optional

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

Property kmsId:.

period^Optional

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

Property period: The subscription duration of the subscription cluster.

Valid values when Period is set to Year: 1 to 3 (integer). Valid values when Period is set to Month: 1 to 9 (integer). Note This parameter must be specified when PayType is set to Prepaid.

period_type^Optional

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

Property periodType: The subscription type of the subscription cluster.

Valid values: Year: subscription on a yearly basis. Month: subscription on a monthly basis. Note This parameter must be specified when PayType is set to Prepaid.

product_form^Optional

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

Property productForm: Valid values: IntegrationForm LegacyForm.

product_version^Optional

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

Property productVersion: The version of the cluster.Note If only ProductForm is set to IntegrationForm, enter this parameter.

reserved_node_count^Optional

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

Property reservedNodeCount: The number of reserved nodes.

Must be 1 for basic version and multiple of 3 for enterprise version.

reserved_node_size^Optional

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

Property reservedNodeSize: The size of each reserved node.

resource_group_id^Optional

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

Property resourceGroupId: The resource group ID.

restore_to_time^Optional

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

Property restoreToTime: The point in time to which you want to restore data from the backup set.

restore_type^Optional

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

Property restoreType: The method that you want to use to restore data.

Valid values: backup: restores data from a backup set. You must also specify the BackupSetId and SourceDBClusterId parameters. timepoint: restores data to a point in time. You must also specify the RestoreToTime and SourceDBClusterId parameters.

secondary_v_switch_id^Optional

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

Property secondaryVSwitchId: The secondary vSwitch ID of the cluster.

secondary_zone_id^Optional

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

Property secondaryZoneId: The secondary zone ID.

source_db_cluster_id^Optional

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

Property sourceDbClusterId: The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster.

If you want to restore a Data Lakehouse Edition cluster from a Data Warehouse Edition cluster, you must specify this parameter.

storage_resource^Optional

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

Property storageResource: The amount of reserved storage resources.

Unit: AnalyticDB compute units (ACUs). Valid values: 0ACU to 2064ACU. The value must be in increments of 24 ACUs. Each ACU is equivalent to 1 core and 4 GB memory. Note This parameter must be specified with a unit.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to cluster.

Max support 20 tags to add during create cluster. Each tag with two properties Key and Value, and Key is required.

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_adblake
ros_cdk_adblake.DBCluster.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_connection_string^Required

attr_connection_string: typing.Union[str, IResolvable]

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

Attribute ConnectionString: The public endpoint that is used to connect to the cluster.

attr_db_cluster_id^Required

attr_db_cluster_id: typing.Union[str, IResolvable]

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

Attribute DBClusterId: The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

attr_order_id^Required

attr_order_id: typing.Union[str, IResolvable]

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

Attribute OrderId: The order ID.

props^Required

props: DBClusterProps

• Type: DBClusterProps