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(
  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
)

Properties

db_cluster_version^Required

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_type^Required

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.

vpc_id^Required

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_id^Required

v_switch_id: typing.Union[str, IResolvable]

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

Property vSwitchId: The vSwitch ID of the cluster.

zone_id^Required

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_id^Optional

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.

clone_source_region_id^Optional

clone_source_region_id: typing.Union[str, IResolvable]

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

Property cloneSourceRegionId: The region ID of the source cluster.

This parameter is required for cross-region cloning.

compute_resource^Optional

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_description^Optional

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

db_cluster_network_type^Optional

db_cluster_network_type: typing.Union[str, IResolvable]

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

Property dbClusterNetworkType: The network type of the cluster.

Valid values: VPC

disk_encryption^Optional

disk_encryption: typing.Union[bool, IResolvable]

• 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

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

kms_id^Optional

kms_id: typing.Union[str, IResolvable]

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

Property kmsId: The ID of the key used to encrypt data on cloud disks.

This parameter takes effect only when disk encryption is enabled for the AnalyticDB for MySQL cluster.

period^Optional

period: typing.Union[str, IResolvable]

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

Property period: The unit of the subscription duration.

Valid values:

• Year
• Month

This parameter is required if you set PayType to Prepaid.

period_type^Optional

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.

product_form^Optional

product_form: typing.Union[str, IResolvable]

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

Property productForm: The product form.

Valid values:

• IntegrationForm: Integration Form.
• LegacyForm: Data Lakehouse Edition.

product_version^Optional

product_version: typing.Union[str, IResolvable]

• 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

reserved_node_count: typing.Union[typing.Union[int, float], IResolvable]

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

Property reservedNodeCount: The number of reserved nodes.

• For Enterprise Edition, the value must be a multiple of 3. The default value is

1.

• For Basic Edition, the default value is 1.

This parameter is available only when ProductForm is set to IntegrationForm.

reserved_node_size^Optional

reserved_node_size: typing.Union[typing.Union[int, float], IResolvable]

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

Property reservedNodeSize: The resource specification of each reserved node, in ACUs.

resource_group_id^Optional

resource_group_id: typing.Union[str, IResolvable]

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

Property resourceGroupId: The resource group ID.

restore_to_time^Optional

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 the cluster.

Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

restore_type^Optional

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.

secondary_v_switch_id^Optional

secondary_v_switch_id: typing.Union[str, IResolvable]

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

Property secondaryVSwitchId: The ID of the secondary vSwitch.

The value of this parameter cannot be the same as the value of the VSwitchId parameter.

secondary_zone_id^Optional

secondary_zone_id: typing.Union[str, IResolvable]

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

Property secondaryZoneId: The ID of the secondary availability zone.

The value of this parameter cannot be the same as the value of the ZoneId parameter.

source_db_cluster_id^Optional

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.

storage_resource^Optional

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.

tags^Optional

tags: typing.List[TagsProperty]

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