DBInstanceProps

Properties for defining a DBInstance.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Gpdb;
new DBInstanceProps {
    object EngineVersion,
    object VSwitchId,
    object ZoneId,
    object CreateSampleData = null,
    object DbInstanceCategory = null,
    object DbInstanceClass = null,
    object DbInstanceDescription = null,
    object DbInstanceGroupCount = null,
    object DbInstanceMode = null,
    object EncryptionKey = null,
    object EncryptionType = null,
    object IdleTime = null,
    object InstanceSpec = null,
    object MasterNodeNum = null,
    object PayType = null,
    object Period = null,
    object PeriodUnit = null,
    object PrivateIpAddress = null,
    object ProdType = null,
    object SecurityIpList = null,
    object SegDiskPerformanceLevel = null,
    object SegNodeNum = null,
    object SegStorageType = null,
    object ServerlessMode = null,
    object ServerlessResource = null,
    object StorageSize = null,
    TagsProperty[] Tags = null,
    object VectorConfigurationStatus = null,
    object VpcId = null
};

Properties

Name	Type	Description
EngineVersion	object	Property engineVersion: The version of the database engine.
VSwitchId	object	Property vSwitchId: The vSwitch ID of the instance.
ZoneId	object	Property zoneId: The zone ID of the instance, such as cn-hangzhou-d.
CreateSampleData	object	Property createSampleData: Whether to load the sample data set after the instance is created.
DbInstanceCategory	object	Property dbInstanceCategory: DB instance category, valid values: Basic, HighAvailability.
DbInstanceClass	object	Property dbInstanceClass: The instance type.
DbInstanceDescription	object	Property dbInstanceDescription: The description of the instance.
DbInstanceGroupCount	object	Property dbInstanceGroupCount: The number of compute nodes in the instance.
DbInstanceMode	object	Property dbInstanceMode: The db instance mode.
EncryptionKey	object	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	object	Property encryptionType: The type of the encryption.
IdleTime	object	Property idleTime: Idle release wait time.
InstanceSpec	object	Property instanceSpec: The specification of segment nodes.
MasterNodeNum	object	Property masterNodeNum: The number of master nodes.
PayType	object	Property payType: The billing method of the instance.
Period	object	Property period: The subscription period.
PeriodUnit	object	Property periodUnit: Unit of subscription period, it could be Month\/Year.
PrivateIpAddress	object	Property privateIpAddress: Private IP address.
ProdType	object	Property prodType: Prod type.
SecurityIpList	object	Property securityIpList: The whitelist of IP addresses that are allowed to access the instance.
SegDiskPerformanceLevel	object	Property segDiskPerformanceLevel: Seg disk performance level.
SegNodeNum	object	Property segNodeNum: Calculate the number of nodes.
SegStorageType	object	Property segStorageType: The disk type of segment nodes.
ServerlessMode	object	Property serverlessMode: Mode of the Serverless instance.
ServerlessResource	object	Property serverlessResource: Computing resource threshold.
StorageSize	object	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	object	Property vectorConfigurationStatus: the status of vector configuration.
VpcId	object	Property vpcId: The VPC ID of the instance.

---

EngineVersion^Required

public object EngineVersion { get; set; }

• Type: object

Property engineVersion: The version of the database engine.

For example: 6.0、7.0

---

VSwitchId^Required

public object VSwitchId { get; set; }

• Type: object

Property vSwitchId: The vSwitch ID of the instance.

---

ZoneId^Required

public object ZoneId { get; set; }

• Type: object

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

public object CreateSampleData { get; set; }

• Type: object

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

public object DbInstanceCategory { get; set; }

• Type: object

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

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

---

DbInstanceClass^Optional

public object DbInstanceClass { get; set; }

• Type: object

Property dbInstanceClass: The instance type.

---

DbInstanceDescription^Optional

public object DbInstanceDescription { get; set; }

• Type: object

Property dbInstanceDescription: The description of the instance.

The description cannot exceed 256 characters in length.

---

DbInstanceGroupCount^Optional

public object DbInstanceGroupCount { get; set; }

• Type: object

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

public object DbInstanceMode { get; set; }

• Type: object

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.

---

EncryptionKey^Optional

public object EncryptionKey { get; set; }

• Type: object

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

public object EncryptionType { get; set; }

• Type: object

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

public object IdleTime { get; set; }

• Type: object

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

public object InstanceSpec { get; set; }

• Type: object

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

public object MasterNodeNum { get; set; }

• Type: object

Property masterNodeNum: The number of master nodes.

Minimum is 1, max is 2.

---

PayType^Optional

public object PayType { get; set; }

• Type: object

Property payType: The billing method of the instance.

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

---

Period^Optional

public object Period { get; set; }

• Type: object

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

public object PeriodUnit { get; set; }

• Type: object

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

Default value is Month.

---

PrivateIpAddress^Optional

public object PrivateIpAddress { get; set; }

• Type: object

Property privateIpAddress: Private IP address.

---

ProdType^Optional

public object ProdType { get; set; }

• Type: object

Property prodType: Prod type.

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

---

SecurityIpList^Optional

public object SecurityIpList { get; set; }

• Type: object

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

Default value: 127.0.0.1.

---

SegDiskPerformanceLevel^Optional

public object SegDiskPerformanceLevel { get; set; }

• Type: object

Property segDiskPerformanceLevel: Seg disk performance level.

The value can be: pl0、pl1 and pl2

---

SegNodeNum^Optional

public object SegNodeNum { get; set; }

• Type: object

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

public object SegStorageType { get; set; }

• Type: object

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

public object ServerlessMode { get; set; }

• Type: object

Property serverlessMode: Mode of the Serverless instance.

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

---

ServerlessResource^Optional

public object ServerlessResource { get; set; }

• Type: object

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

public object StorageSize { get; set; }

• Type: object

Property storageSize: The storage capacity of per segment node.

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

---

Tags^Optional

public TagsProperty[] Tags { get; set; }

• 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

public object VectorConfigurationStatus { get; set; }

• Type: object

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

public object VpcId { get; set; }

• Type: object

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.

---