DBInstanceProps

Properties for defining a DBInstance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-gpdb-dbinstance

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkgpdb"
&alicloudroscdkgpdb.DBInstanceProps {
    EngineVersion: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
    CreateSampleData: interface{},
    DbInstanceCategory: interface{},
    DbInstanceClass: interface{},
    DbInstanceDescription: interface{},
    DbInstanceGroupCount: interface{},
    DbInstanceMode: interface{},
    EncryptionKey: interface{},
    EncryptionType: interface{},
    IdleTime: interface{},
    InstanceSpec: interface{},
    MasterNodeNum: interface{},
    PayType: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    PrivateIpAddress: interface{},
    ProdType: interface{},
    SecurityIpList: interface{},
    SegDiskPerformanceLevel: interface{},
    SegNodeNum: interface{},
    SegStorageType: interface{},
    ServerlessMode: interface{},
    ServerlessResource: interface{},
    StorageSize: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkgpdb.RosDBInstance.TagsProperty,
    VectorConfigurationStatus: interface{},
    VpcId: interface{},
}

Properties

Name	Type	Description
EngineVersion	interface{}	Property engineVersion: The version of the database engine.
VSwitchId	interface{}	Property vSwitchId: The vSwitch ID of the instance.
ZoneId	interface{}	Property zoneId: The zone ID of the instance, such as cn-hangzhou-d.
CreateSampleData	interface{}	Property createSampleData: Whether to load the sample data set after the instance is created.
DbInstanceCategory	interface{}	Property dbInstanceCategory: DB instance category, valid values: Basic, HighAvailability.
DbInstanceClass	interface{}	Property dbInstanceClass: The instance type.
DbInstanceDescription	interface{}	Property dbInstanceDescription: The description of the instance.
DbInstanceGroupCount	interface{}	Property dbInstanceGroupCount: The number of compute nodes in the instance.
DbInstanceMode	interface{}	Property dbInstanceMode: The db instance mode.
EncryptionKey	interface{}	Property encryptionKey: If the EncryptionType parameter is set to CloudDisk, you must specify this parameter to the encryption key that is in the same region with the disks that is specified by the EncryptionType parameter.
EncryptionType	interface{}	Property encryptionType: The type of the encryption.
IdleTime	interface{}	Property idleTime: Idle release wait time.
InstanceSpec	interface{}	Property instanceSpec: The specification of segment nodes.
MasterNodeNum	interface{}	Property masterNodeNum: The number of master nodes.
PayType	interface{}	Property payType: The billing method of the instance.
Period	interface{}	Property period: The subscription period.
PeriodUnit	interface{}	Property periodUnit: Unit of subscription period, it could be Month\/Year.
PrivateIpAddress	interface{}	Property privateIpAddress: Private IP address.
ProdType	interface{}	Property prodType: Prod type.
SecurityIpList	interface{}	Property securityIpList: The whitelist of IP addresses that are allowed to access the instance.
SegDiskPerformanceLevel	interface{}	Property segDiskPerformanceLevel: Seg disk performance level.
SegNodeNum	interface{}	Property segNodeNum: Calculate the number of nodes.
SegStorageType	interface{}	Property segStorageType: The disk type of segment nodes.
ServerlessMode	interface{}	Property serverlessMode: Mode of the Serverless instance.
ServerlessResource	interface{}	Property serverlessResource: Computing resource threshold.
StorageSize	interface{}	Property storageSize: The storage capacity of per segment node.
Tags	*[]TagsProperty	Property tags: The list of instance tags in the form of key\/value pairs.
VectorConfigurationStatus	interface{}	Property vectorConfigurationStatus: the status of vector configuration.
VpcId	interface{}	Property vpcId: The VPC ID of the instance.

---

EngineVersion^Required

EngineVersion interface{}

• Type: interface{}

Property engineVersion: The version of the database engine.

For example: 6.0、7.0

---

VSwitchId^Required

VSwitchId interface{}

• Type: interface{}

Property vSwitchId: The vSwitch ID of the instance.

---

ZoneId^Required

ZoneId interface{}

• Type: interface{}

Property zoneId: The zone ID of the instance, such as cn-hangzhou-d.

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

---

CreateSampleData^Optional

CreateSampleData interface{}

• Type: interface{}

Property createSampleData: Whether to load the sample data set after the instance is created.

The value can be: true: load the sample dataset. false: not to load the sample dataset

---

DbInstanceCategory^Optional

DbInstanceCategory interface{}

• Type: interface{}

Property dbInstanceCategory: DB instance category, valid values: Basic, HighAvailability.

This parameter must be passed in to create a storage reservation mode instance.

---

DbInstanceClass^Optional

DbInstanceClass interface{}

• Type: interface{}

Property dbInstanceClass: The instance type.

---

DbInstanceDescription^Optional

DbInstanceDescription interface{}

• Type: interface{}

Property dbInstanceDescription: The description of the instance.

The description cannot exceed 256 characters in length.

---

DbInstanceGroupCount^Optional

DbInstanceGroupCount interface{}

• Type: interface{}

Property dbInstanceGroupCount: The number of compute nodes in the instance.

The value can be 2, 4, 8, 12, 16, 24, 32, 64, 96, or 128.

---

DbInstanceMode^Optional

DbInstanceMode interface{}

• Type: interface{}

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.

---

EncryptionKey^Optional

EncryptionKey interface{}

• Type: interface{}

Property encryptionKey: If the EncryptionType parameter is set to CloudDisk, you must specify this parameter to the encryption key that is in the same region with the disks that is specified by the EncryptionType parameter.

Otherwise, leave this parameter empty.

---

EncryptionType^Optional

EncryptionType interface{}

• Type: interface{}

Property encryptionType: The type of the encryption.

Default value: NULL. Valid values: NULL: Encryption is disabled. CloudDisk: Encryption is enabled on disks and the encryption key is specified by using the EncryptionKey parameter. Note: Disk encryption cannot be disabled after it is enabled.

---

IdleTime^Optional

IdleTime interface{}

• Type: interface{}

Property idleTime: Idle release wait time.

That is, when the period of no service traffic reaches the specified period, the instance becomes idle. The unit is second. The minimum value is 60. The default value is 600.

---

InstanceSpec^Optional

InstanceSpec interface{}

• Type: interface{}

Property instanceSpec: The specification of segment nodes.

• When DBInstanceCategory is HighAvailability, Valid values: 2C16G, 4C32G, 8C64G, 16C128G.
• When DBInstanceCategory is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
• When DBInstanceCategory is Serverless, Valid values: 4C16G, 8C32G. This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

---

MasterNodeNum^Optional

MasterNodeNum interface{}

• Type: interface{}

Property masterNodeNum: The number of master nodes.

Minimum is 1, max is 2.

---

PayType^Optional

PayType interface{}

• Type: interface{}

Property payType: The billing method of the instance.

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

---

Period^Optional

Period interface{}

• Type: interface{}

Property period: The subscription period.

While choose by pay by month, it could be from 1 to 11. While choose pay by year, it could be from 1 to 3.

---

PeriodUnit^Optional

PeriodUnit interface{}

• Type: interface{}

Property periodUnit: Unit of subscription period, it could be Month\/Year.

Default value is Month.

---

PrivateIpAddress^Optional

PrivateIpAddress interface{}

• Type: interface{}

Property privateIpAddress: Private IP address.

---

ProdType^Optional

ProdType interface{}

• Type: interface{}

Property prodType: Prod type.

The value can be: standard, cost-effective. The default value is standard.

---

SecurityIpList^Optional

SecurityIpList interface{}

• Type: interface{}

Property securityIpList: The whitelist of IP addresses that are allowed to access the instance.

Default value: 127.0.0.1.

---

SegDiskPerformanceLevel^Optional

SegDiskPerformanceLevel interface{}

• Type: interface{}

Property segDiskPerformanceLevel: Seg disk performance level.

The value can be: pl0、pl1 and pl2

---

SegNodeNum^Optional

SegNodeNum interface{}

• Type: interface{}

Property segNodeNum: Calculate the number of nodes.

The value can be:

• When DBInstanceMode is StorageElastic and DBInstanceCategory is HighAvailability, the value ranges from 4 to 512. The value must be a multiple of 4.
• When DBInstanceMode is StorageElastic and DBInstanceCategory is Basic, the value ranges from 2 to 512. The value must be a multiple of 2.
• When DBInstanceMode is Serverless, The value ranges from 2 to 512. The value must be a multiple of 2.

---

SegStorageType^Optional

SegStorageType interface{}

• Type: interface{}

Property segStorageType: The disk type of segment nodes.

For example: cloud_essd, cloud_efficiency. This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

---

ServerlessMode^Optional

ServerlessMode interface{}

• Type: interface{}

Property serverlessMode: Mode of the Serverless instance.

The value can be: Manual: manual scheduling is the default value. Auto: indicates automatic scheduling.

---

ServerlessResource^Optional

ServerlessResource interface{}

• Type: interface{}

Property serverlessResource: Computing resource threshold.

The value ranges from 8 to 32. The step length is 8. The unit is ACU. The default value is 32.

---

StorageSize^Optional

StorageSize interface{}

• Type: interface{}

Property storageSize: The storage capacity of per segment node.

Unit: GB. Minimum is 50, max is 4000, step is 50.

---

Tags^Optional

Tags *[]TagsProperty

• Type: *[]TagsProperty

Property tags: The list of instance tags in the form of key\/value pairs.

You can define a maximum of 20 tags for instance.

---

VectorConfigurationStatus^Optional

VectorConfigurationStatus interface{}

• Type: interface{}

Property vectorConfigurationStatus: the status of vector configuration.

The value can be:Y: Turn on vector engine optimization.N: Turn off vector engine optimization (default value).

---

VpcId^Optional

VpcId interface{}

• Type: interface{}

Property vpcId: The VPC ID of the instance.

If you set the InstanceNetworkType parameter to VPC, you must also specify the VPCId parameter. The specified region of the VPC must be the same as the RegionId value.

---