Skip to content

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

Name Type Description
computeResource string | @alicloud/ros-cdk-core.IResolvable Property computeResource: The amount of reserved computing resources.
dbClusterVersion string | @alicloud/ros-cdk-core.IResolvable Property dbClusterVersion: The version of the cluster.
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The billing method of the cluster.
storageResource string | @alicloud/ros-cdk-core.IResolvable Property storageResource: The amount of reserved storage resources.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The virtual private cloud (VPC) ID of the cluster.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The vSwitch ID of the cluster.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone ID.
backupSetId string | @alicloud/ros-cdk-core.IResolvable Property backupSetId: The ID of the backup set that you want to use to restore data.
dbClusterDescription string | @alicloud/ros-cdk-core.IResolvable Property dbClusterDescription: The description of the cluster.
enableDefaultResourcePool boolean | @alicloud/ros-cdk-core.IResolvable Property enableDefaultResourcePool: Specifies whether to allocate all reserved computing resources to the user_default resource group.
period string | @alicloud/ros-cdk-core.IResolvable Property period: The subscription duration of the subscription cluster.
periodType string | @alicloud/ros-cdk-core.IResolvable Property periodType: The subscription type of the subscription cluster.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The resource group ID.
restoreToTime string | @alicloud/ros-cdk-core.IResolvable Property restoreToTime: The point in time to which you want to restore data from the backup set.
restoreType string | @alicloud/ros-cdk-core.IResolvable Property restoreType: The method that you want to use to restore data.
sourceDbClusterId string | @alicloud/ros-cdk-core.IResolvable Property sourceDbClusterId: The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster.
tags TagsProperty[] Property tags: Tags to attach to cluster.

computeResourceRequired 

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.

dbClusterVersionRequired 

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.

payTypeRequired 

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.

storageResourceRequired 

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.

vpcIdRequired 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

vSwitchIdRequired 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The vSwitch ID of the cluster.

zoneIdRequired 

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.

backupSetIdOptional 

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.

dbClusterDescriptionOptional 

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

enableDefaultResourcePoolOptional 

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

periodOptional 

public readonly period: string | IResolvable;
  • Type: string | @alicloud/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.

periodTypeOptional 

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.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The resource group ID.

restoreToTimeOptional 

public readonly restoreToTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property restoreToTime: The point in time to which you want to restore data from the backup set.

restoreTypeOptional 

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.

sourceDbClusterIdOptional 

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.

tagsOptional 

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