DBClusterProps

Properties for defining a DBCluster.

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

Initializer

import { DBClusterProps } from '@alicloud/ros-cdk-adblake'
const dBClusterProps: DBClusterProps = { ... }

Properties

dbClusterVersion^Required

public readonly dbClusterVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterVersion: The version of the cluster.

Set the value to 5.0.

payType^Required

public readonly payType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property payType: The billing method of the cluster.

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

vpcId^Required

public readonly vpcId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

vSwitchId^Required

public readonly vSwitchId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The vSwitch ID of the cluster.

zoneId^Required

public readonly zoneId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The zone ID.

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

backupSetId^Optional

public readonly backupSetId: string | IResolvable;

• Type: string | @alicloud/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.

cloneSourceRegionId^Optional

public readonly cloneSourceRegionId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property cloneSourceRegionId: The region ID of the source cluster.

This parameter is required for cross-region cloning.

computeResource^Optional

public readonly computeResource: string | IResolvable;

• Type: string | @alicloud/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.

dbClusterDescription^Optional

public readonly dbClusterDescription: string | IResolvable;

• Type: string | @alicloud/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

dbClusterNetworkType^Optional

public readonly dbClusterNetworkType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterNetworkType: The network type of the cluster.

Valid values: VPC

diskEncryption^Optional

public readonly diskEncryption: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property diskEncryption: Specifies whether to encrypt the disk.

Valid values: true false (default)

enableDefaultResourcePool^Optional

public readonly enableDefaultResourcePool: boolean | IResolvable;

• Type: boolean | @alicloud/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

kmsId^Optional

public readonly kmsId: string | IResolvable;

• Type: string | @alicloud/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

public readonly period: string | IResolvable;

• Type: string | @alicloud/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.

periodType^Optional

public readonly periodType: string | IResolvable;

• Type: string | @alicloud/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.

productForm^Optional

public readonly productForm: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property productForm: The product form.

Valid values: - IntegrationForm: Integration Form. - LegacyForm: Data Lakehouse Edition.

productVersion^Optional

public readonly productVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

reservedNodeCount^Optional

public readonly reservedNodeCount: number | IResolvable;

• Type: number | @alicloud/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 3. - For Basic Edition, the default value is 1.

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

reservedNodeSize^Optional

public readonly reservedNodeSize: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

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

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The resource group ID.

restoreToTime^Optional

public readonly restoreToTime: string | IResolvable;

• Type: string | @alicloud/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.

restoreType^Optional

public readonly restoreType: string | IResolvable;

• Type: string | @alicloud/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.

secondaryVSwitchId^Optional

public readonly secondaryVSwitchId: string | IResolvable;

• Type: string | @alicloud/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.

secondaryZoneId^Optional

public readonly secondaryZoneId: string | IResolvable;

• Type: string | @alicloud/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.

sourceDbClusterId^Optional

public readonly sourceDbClusterId: string | IResolvable;

• Type: string | @alicloud/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.

storageResource^Optional

public readonly storageResource: string | IResolvable;

• Type: string | @alicloud/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

public readonly tags: TagsProperty[];

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