DBCluster

This class encapsulates and extends the ROS resource type ALIYUN::ADBLake::DBCluster, which is used to create an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

Initializers

import com.aliyun.ros.cdk.adblake.DBCluster;
DBCluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .computeResource(java.lang.String)
    .computeResource(IResolvable)
    .dbClusterVersion(java.lang.String)
    .dbClusterVersion(IResolvable)
    .payType(java.lang.String)
    .payType(IResolvable)
    .storageResource(java.lang.String)
    .storageResource(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .backupSetId(java.lang.String)
//  .backupSetId(IResolvable)
//  .dbClusterDescription(java.lang.String)
//  .dbClusterDescription(IResolvable)
//  .enableDefaultResourcePool(java.lang.Boolean)
//  .enableDefaultResourcePool(IResolvable)
//  .period(java.lang.String)
//  .period(IResolvable)
//  .periodType(java.lang.String)
//  .periodType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .restoreToTime(java.lang.String)
//  .restoreToTime(IResolvable)
//  .restoreType(java.lang.String)
//  .restoreType(IResolvable)
//  .sourceDbClusterId(java.lang.String)
//  .sourceDbClusterId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

Name	Type	Description
`scope`	`com.aliyun.ros.cdk.core.Construct`	No description.
`id`	`java.lang.String`	No description.
`enableResourcePropertyConstraint`	`java.lang.Boolean`	No description.
`computeResource`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property computeResource: The amount of reserved computing resources.
`dbClusterVersion`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dbClusterVersion: The version of the cluster.
`payType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property payType: The billing method of the cluster.
`storageResource`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property storageResource: The amount of reserved storage resources.
`vpcId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property vpcId: The virtual private cloud (VPC) ID of the cluster.
`vSwitchId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property vSwitchId: The vSwitch ID of the cluster.
`zoneId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property zoneId: The zone ID.
`backupSetId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property backupSetId: The ID of the backup set that you want to use to restore data.
`dbClusterDescription`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dbClusterDescription: The description of the cluster.
`enableDefaultResourcePool`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property enableDefaultResourcePool: Specifies whether to allocate all reserved computing resources to the user_default resource group.
`period`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property period: The subscription duration of the subscription cluster.
`periodType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property periodType: The subscription type of the subscription cluster.
`resourceGroupId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property resourceGroupId: The resource group ID.
`restoreToTime`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property restoreToTime: The point in time to which you want to restore data from the backup set.
`restoreType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property restoreType: The method that you want to use to restore data.
`sourceDbClusterId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property sourceDbClusterId: The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster.
`tags`	`java.util.List<TagsProperty>`	Property tags: Tags to attach to cluster.

`scope`^Required

Type: com.aliyun.ros.cdk.core.Construct

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`computeResource`^Required

Type: java.lang.String OR com.aliyun.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.

`dbClusterVersion`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbClusterVersion: The version of the cluster.

Set the value to 5.0.

`payType`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property payType: The billing method of the cluster.

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

`storageResource`^Required

Type: java.lang.String OR com.aliyun.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.

`vpcId`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

`vSwitchId`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The vSwitch ID of the cluster.

`zoneId`^Required

Type: java.lang.String OR com.aliyun.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

Type: java.lang.String OR com.aliyun.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.

`dbClusterDescription`^Optional

Type: java.lang.String OR com.aliyun.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

`enableDefaultResourcePool`^Optional

Type: java.lang.Boolean OR com.aliyun.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

`period`^Optional

Type: java.lang.String OR com.aliyun.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.

`periodType`^Optional

Type: java.lang.String OR com.aliyun.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.

`resourceGroupId`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The resource group ID.

`restoreToTime`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

`restoreType`^Optional

Type: java.lang.String OR com.aliyun.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.

`sourceDbClusterId`^Optional

Type: java.lang.String OR com.aliyun.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.

`tags`^Optional

Type: java.util.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.

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`addCondition`	No description.
`addCount`	No description.
`addDependency`	No description.
`addResourceDesc`	No description.
`applyRemovalPolicy`	No description.
`getAtt`	No description.
`setMetadata`	No description.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`synthesize`

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

Type: com.aliyun.ros.cdk.core.RosCondition

`addCount`

public void addCount(java.lang.Number OR IResolvable count)

count^Required

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

`addDependency`

public void addDependency(Resource resource)

resource^Required

Type: com.aliyun.ros.cdk.core.Resource

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

Type: com.aliyun.ros.cdk.core.RemovalPolicy

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`isConstruct`

import com.aliyun.ros.cdk.adblake.DBCluster;
DBCluster.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`java.lang.String`	No description.
`stack`	`com.aliyun.ros.cdk.core.Stack`	The stack in which this resource is defined.
`resource`	`com.aliyun.ros.cdk.core.RosResource`	No description.
`attrConnectionString`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ConnectionString: The public endpoint that is used to connect to the cluster.
`attrDbClusterId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute DBClusterId: The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
`attrOrderId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute OrderId: The order ID.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrConnectionString`^Required

public IResolvable getAttrConnectionString();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionString: The public endpoint that is used to connect to the cluster.

`attrDbClusterId`^Required

public IResolvable getAttrDbClusterId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBClusterId: The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

`attrOrderId`^Required

public IResolvable getAttrOrderId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The order ID.

DBCluster

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

computeResourceRequired

dbClusterVersionRequired

payTypeRequired

storageResourceRequired

vpcIdRequired

vSwitchIdRequired

zoneIdRequired

backupSetIdOptional

dbClusterDescriptionOptional

enableDefaultResourcePoolOptional

periodOptional

periodTypeOptional

resourceGroupIdOptional

restoreToTimeOptional

restoreTypeOptional

sourceDbClusterIdOptional

tagsOptional