DBClusterProps

Properties for defining a DBCluster.

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

Initializer

import ros_cdk_adb
ros_cdk_adb.DBClusterProps(
  db_cluster_category: typing.Union[str, IResolvable],
  db_cluster_version: typing.Union[str, IResolvable],
  mode: typing.Union[str, IResolvable],
  pay_type: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  compute_resource: typing.Union[str, IResolvable] = None,
  db_cluster_class: typing.Union[str, IResolvable] = None,
  db_cluster_description: typing.Union[str, IResolvable] = None,
  db_node_group_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  db_node_storage: typing.Union[typing.Union[int, float], IResolvable] = None,
  disk_encryption: typing.Union[bool, IResolvable] = None,
  elastic_io_resource: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_ssl: typing.Union[bool, IResolvable] = None,
  executor_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  kms_id: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_type: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  zone_id: typing.Union[str, IResolvable] = None
)

Properties

db_cluster_category^Required

db_cluster_category: typing.Union[str, IResolvable]

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

Property dbClusterCategory: The cluster edition.

Valid values:

• Cluster: reserved cluster.

Reserved clusters are available only in the Chinese mainland and Singapore regions. In the Singapore region, you can purchase reserved clusters only with the pay-as-you-go billing method.

• MixedStorage: elastic cluster (new).

If you set DBClusterCategory to Cluster, you must set the Mode parameter to Reserved. If you set DBClusterCategory to MixedStorage, you must set the Mode parameter to Flexible. Otherwise, cluster creation will fail.

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

mode^Required

mode: typing.Union[str, IResolvable]

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

Property mode: The cluster mode.

Valid values:

• Reserved: reserved mode.
• Flexible: flexible mode.

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 ID of the VPC.

v_switch_id^Required

v_switch_id: typing.Union[str, IResolvable]

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

Property vSwitchId: The ID of the vSwitch.

compute_resource^Optional

compute_resource: typing.Union[str, IResolvable]

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

Property computeResource: The compute resources for the cluster.

Compute resources are used for data queries. A larger amount of compute resources can provide better query performance. Compute resources are available in cluster and single-node editions:

• Cluster edition: includes specifications such as 16 cores/64 GB, 24 cores/96 GB, and 32 cores or more. The cluster edition supports resource pool isolation, scheduled scaling, and tiered storage of hot and cold data.
• Single-node edition: includes specifications such as 8 cores/32 GB and 16 cores/64 GB. The single-node edition does not provide an SLA guarantee and has a long recovery time from failures (4 to 8 hours). We do not recommend that you use the single-node edition in production environments.

• You can call the DescribeAvailableResource operation to query the compute resources that are available in a specific region.
• This parameter is required when Mode is set to Flexible (flexible mode).

db_cluster_class^Optional

db_cluster_class: typing.Union[str, IResolvable]

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

Property dbClusterClass: The specification of the cluster.

This parameter is required in reserved mode. Valid values: Basic Edition: T8, T16, T32, and T52 Cluster Edition: C8 and C32

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

db_node_group_count^Optional

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

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

Property dbNodeGroupCount: The number of node groups.

The value must be an integer from 1 to 200.

This parameter is required when Mode is set to Reserved (reserved mode).

db_node_storage^Optional

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

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

Property dbNodeStorage: The storage space of the node.

This parameter is required in reserved mode. Unit: GB. Valid values: T8: 100 to 500 T16 and T32: 100 to 2000 T52: 100 to 4000 C8: 100 to 1000 C32: 100 to 8000 Note The storage space less than 1,000 GB increases in increments of 100 GB. The storage space greater than 1,000 GB increases in increments of 1,000 GB.

disk_encryption^Optional

disk_encryption: typing.Union[bool, IResolvable]

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

Property diskEncryption: Whether to enable cloud disk encryption. Value:.

• true: yes.
• false: no.

elastic_io_resource^Optional

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

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

Property elasticIoResource: The number of Elastic IO Units (EIUs).

enable_ssl^Optional

enable_ssl: typing.Union[bool, IResolvable]

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

Property enableSsl: Whether to enable SSL link encryption function, value:.

• true: open.
• false: close.

executor_count^Optional

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

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

Property executorCount: This parameter is reserved.

kms_id^Optional

kms_id: typing.Union[str, IResolvable]

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

Property kmsId: The kmsId used for cloud disk encryption, effective only when DiskEncryption is true.

period^Optional

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

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

Property period: The subscription period unit.

Valid values:

• Year
• Month

This parameter is required when PayType is set to Prepaid (subscription).

period_type^Optional

period_type: typing.Union[str, IResolvable]

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

Property periodType: The subscription period for the cluster.

This parameter is required if the PayType parameter is set to Prepaid. Valid values: Year: subscription on a yearly basis Month: subscription on a monthly basis

resource_group_id^Optional

resource_group_id: typing.Union[str, IResolvable]

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

Property resourceGroupId: The ID of the resource group.

tags^Optional

tags: typing.List[TagsProperty]

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to instance.

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

zone_id^Optional

zone_id: typing.Union[str, IResolvable]

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

Property zoneId: The zone ID of the cluster.

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