Skip to content

DBClusterProps

Properties for defining a DBCluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-adblake-dbcluster

Initializer 

import ros_cdk_adblake
ros_cdk_adblake.DBClusterProps(
  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
)

Properties

Name Type 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.

compute_resourceRequired 

compute_resource: typing.Union[str, IResolvable]
  • 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_versionRequired 

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

Property dbClusterVersion: The version of the cluster.

Set the value to 5.0.

pay_typeRequired 

pay_type: typing.Union[str, IResolvable]
  • 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_resourceRequired 

storage_resource: typing.Union[str, IResolvable]
  • 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_idRequired 

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

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

v_switch_idRequired 

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

Property vSwitchId: The vSwitch ID of the cluster.

zone_idRequired 

zone_id: typing.Union[str, IResolvable]
  • 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_idOptional 

backup_set_id: typing.Union[str, IResolvable]
  • 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_descriptionOptional 

db_cluster_description: typing.Union[str, IResolvable]
  • 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_poolOptional 

enable_default_resource_pool: typing.Union[bool, IResolvable]
  • 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

periodOptional 

period: typing.Union[str, IResolvable]
  • 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_typeOptional 

period_type: typing.Union[str, IResolvable]
  • 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_idOptional 

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

Property resourceGroupId: The resource group ID.

restore_to_timeOptional 

restore_to_time: typing.Union[str, IResolvable]
  • 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_typeOptional 

restore_type: typing.Union[str, IResolvable]
  • 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_idOptional 

source_db_cluster_id: typing.Union[str, IResolvable]
  • 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.

tagsOptional 

tags: 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.