DBCluster

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

Initializers

import ros_cdk_adblake
ros_cdk_adblake.DBCluster(
  scope: Construct,
  id: str,
  compute_resource: typing.Union[str, IResolvable],
  db_cluster_version: typing.Union[str, IResolvable],
  pay_type: typing.Union[str, IResolvable],
  storage_resource: 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,
  db_cluster_description: typing.Union[str, IResolvable] = None,
  enable_default_resource_pool: typing.Union[bool, IResolvable] = None,
  period: typing.Union[str, IResolvable] = None,
  period_type: typing.Union[str, 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,
  source_db_cluster_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
`scope`	`ros_cdk_core.Construct`	No description.
`id`	`str`	No description.
`compute_resource`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property computeResource: The amount of reserved computing resources.
`db_cluster_version`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property dbClusterVersion: The version of the cluster.
`pay_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property payType: The billing method of the cluster.
`storage_resource`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property storageResource: The amount of reserved storage resources.
`vpc_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property vpcId: The virtual private cloud (VPC) ID of the cluster.
`v_switch_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property vSwitchId: The vSwitch ID of the cluster.
`zone_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property zoneId: The zone ID.
`backup_set_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property backupSetId: The ID of the backup set that you want to use to restore data.
`db_cluster_description`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property dbClusterDescription: The description of the cluster.
`enable_default_resource_pool`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property enableDefaultResourcePool: Specifies whether to allocate all reserved computing resources to the user_default resource group.
`period`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property period: The subscription duration of the subscription cluster.
`period_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property periodType: The subscription type of the subscription cluster.
`resource_group_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property resourceGroupId: The resource group ID.
`restore_to_time`	`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`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property restoreType: The method that you want to use to restore data.
`source_db_cluster_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property sourceDbClusterId: The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster.
`tags`	`typing.List[TagsProperty]`	Property tags: Tags to attach to cluster.
`enable_resource_property_constraint`	`bool`	No description.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`compute_resource`^Required

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_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.

`storage_resource`^Required

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.

`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.

`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

`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

`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.

`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.

`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.

`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

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_adblake
ros_cdk_adblake.DBCluster.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.
`attr_connection_string`	`ros_cdk_core.IResolvable`	Attribute ConnectionString: The public endpoint that is used to connect to the cluster.
`attr_db_cluster_id`	`ros_cdk_core.IResolvable`	Attribute DBClusterId: The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
`attr_order_id`	`ros_cdk_core.IResolvable`	Attribute OrderId: The order ID.

`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

`attr_connection_string`^Required

attr_connection_string: IResolvable

Type: 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: IResolvable

Type: 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: IResolvable

Type: ros_cdk_core.IResolvable

Attribute OrderId: The order ID.

DBCluster

Initializers

scopeRequired

idRequired

compute_resourceRequired

db_cluster_versionRequired

pay_typeRequired

storage_resourceRequired

vpc_idRequired

v_switch_idRequired

zone_idRequired

backup_set_idOptional

db_cluster_descriptionOptional

enable_default_resource_poolOptional

periodOptional

period_typeOptional

resource_group_idOptional

restore_to_timeOptional

restore_typeOptional

source_db_cluster_idOptional

tagsOptional

enable_resource_property_constraintOptional