DBClusterProps
Properties for defining a DBCluster.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-adblake-dbcluster
Initializer
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkadblake"
&alicloudroscdkadblake.DBClusterProps {
DbClusterVersion: interface{},
PayType: interface{},
VpcId: interface{},
VSwitchId: interface{},
ZoneId: interface{},
BackupSetId: interface{},
CloneSourceRegionId: interface{},
ComputeResource: interface{},
DbClusterDescription: interface{},
DbClusterNetworkType: interface{},
DiskEncryption: interface{},
EnableDefaultResourcePool: interface{},
KmsId: interface{},
Period: interface{},
PeriodType: interface{},
ProductForm: interface{},
ProductVersion: interface{},
ReservedNodeCount: interface{},
ReservedNodeSize: interface{},
ResourceGroupId: interface{},
RestoreToTime: interface{},
RestoreType: interface{},
SecondaryVSwitchId: interface{},
SecondaryZoneId: interface{},
SourceDbClusterId: interface{},
StorageResource: interface{},
Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkadblake.RosDBCluster.TagsProperty,
}
Properties
| Name | Type | Description |
|---|---|---|
DbClusterVersion | interface{} | Property dbClusterVersion: The version of the cluster. |
PayType | interface{} | Property payType: The billing method of the cluster. |
VpcId | interface{} | Property vpcId: The virtual private cloud (VPC) ID of the cluster. |
VSwitchId | interface{} | Property vSwitchId: The vSwitch ID of the cluster. |
ZoneId | interface{} | Property zoneId: The zone ID. |
BackupSetId | interface{} | Property backupSetId: The ID of the backup set that you want to use to restore data. |
CloneSourceRegionId | interface{} | Property cloneSourceRegionId: The region ID of the source cluster. |
ComputeResource | interface{} | Property computeResource: The amount of reserved computing resources. |
DbClusterDescription | interface{} | Property dbClusterDescription: The description of the cluster. |
DbClusterNetworkType | interface{} | Property dbClusterNetworkType: The network type of the cluster. |
DiskEncryption | interface{} | Property diskEncryption: Specifies whether to encrypt the disk. |
EnableDefaultResourcePool | interface{} | Property enableDefaultResourcePool: Specifies whether to allocate all reserved computing resources to the user_default resource group. |
KmsId | interface{} | Property kmsId: The ID of the key used to encrypt data on cloud disks. |
Period | interface{} | Property period: The unit of the subscription duration. |
PeriodType | interface{} | Property periodType: The subscription type of the subscription cluster. |
ProductForm | interface{} | Property productForm: The product form. |
ProductVersion | interface{} | Property productVersion: The version of the cluster.Note If only ProductForm is set to IntegrationForm, enter this parameter. |
ReservedNodeCount | interface{} | Property reservedNodeCount: The number of reserved nodes. |
ReservedNodeSize | interface{} | Property reservedNodeSize: The resource specification of each reserved node, in ACUs. |
ResourceGroupId | interface{} | Property resourceGroupId: The resource group ID. |
RestoreToTime | interface{} | Property restoreToTime: The point in time to which you want to restore the cluster. |
RestoreType | interface{} | Property restoreType: The method that you want to use to restore data. |
SecondaryVSwitchId | interface{} | Property secondaryVSwitchId: The ID of the secondary vSwitch. |
SecondaryZoneId | interface{} | Property secondaryZoneId: The ID of the secondary availability zone. |
SourceDbClusterId | interface{} | Property sourceDbClusterId: The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster. |
StorageResource | interface{} | Property storageResource: The amount of reserved storage resources. |
Tags | *[]TagsProperty | Property tags: Tags to attach to cluster. |
DbClusterVersionRequired
DbClusterVersion interface{}
- Type: interface{}
Property dbClusterVersion: The version of the cluster.
Set the value to 5.0.
PayTypeRequired
PayType interface{}
- Type: interface{}
Property payType: The billing method of the cluster.
Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.
VpcIdRequired
VpcId interface{}
- Type: interface{}
Property vpcId: The virtual private cloud (VPC) ID of the cluster.
VSwitchIdRequired
VSwitchId interface{}
- Type: interface{}
Property vSwitchId: The vSwitch ID of the cluster.
ZoneIdRequired
ZoneId interface{}
- Type: interface{}
Property zoneId: The zone ID.
Note You can call the DescribeRegions operation to query the most recent zone list.
BackupSetIdOptional
BackupSetId interface{}
- Type: interface{}
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.
CloneSourceRegionIdOptional
CloneSourceRegionId interface{}
- Type: interface{}
Property cloneSourceRegionId: The region ID of the source cluster.
This parameter is required for cross-region cloning.
ComputeResourceOptional
ComputeResource interface{}
- Type: interface{}
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.
DbClusterDescriptionOptional
DbClusterDescription interface{}
- Type: interface{}
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
DbClusterNetworkTypeOptional
DbClusterNetworkType interface{}
- Type: interface{}
Property dbClusterNetworkType: The network type of the cluster.
Valid values: VPC
DiskEncryptionOptional
DiskEncryption interface{}
- Type: interface{}
Property diskEncryption: Specifies whether to encrypt the disk.
Valid values: true false (default)
EnableDefaultResourcePoolOptional
EnableDefaultResourcePool interface{}
- Type: interface{}
Property enableDefaultResourcePool: Specifies whether to allocate all reserved computing resources to the user_default resource group.
Valid values: true (default) false
KmsIdOptional
KmsId interface{}
- Type: interface{}
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.
PeriodOptional
Period interface{}
- Type: interface{}
Property period: The unit of the subscription duration.
Valid values:
- Year
- Month
This parameter is required if you set
PayTypetoPrepaid.
PeriodTypeOptional
PeriodType interface{}
- Type: interface{}
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.
ProductFormOptional
ProductForm interface{}
- Type: interface{}
Property productForm: The product form.
Valid values:
- IntegrationForm: Integration Form.
- LegacyForm: Data Lakehouse Edition.
ProductVersionOptional
ProductVersion interface{}
- Type: interface{}
Property productVersion: The version of the cluster.Note If only ProductForm is set to IntegrationForm, enter this parameter.
ReservedNodeCountOptional
ReservedNodeCount interface{}
- Type: interface{}
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
ProductFormis set toIntegrationForm.
ReservedNodeSizeOptional
ReservedNodeSize interface{}
- Type: interface{}
Property reservedNodeSize: The resource specification of each reserved node, in ACUs.
ResourceGroupIdOptional
ResourceGroupId interface{}
- Type: interface{}
Property resourceGroupId: The resource group ID.
RestoreToTimeOptional
RestoreToTime interface{}
- Type: interface{}
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.
RestoreTypeOptional
RestoreType interface{}
- Type: interface{}
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.
SecondaryVSwitchIdOptional
SecondaryVSwitchId interface{}
- Type: interface{}
Property secondaryVSwitchId: The ID of the secondary vSwitch.
The value of this parameter cannot be the same as the value of the
VSwitchIdparameter.
SecondaryZoneIdOptional
SecondaryZoneId interface{}
- Type: interface{}
Property secondaryZoneId: The ID of the secondary availability zone.
The value of this parameter cannot be the same as the value of the
ZoneIdparameter.
SourceDbClusterIdOptional
SourceDbClusterId interface{}
- Type: interface{}
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.
StorageResourceOptional
StorageResource interface{}
- Type: interface{}
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.
TagsOptional
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.