Skip to content

DBInstanceProps

Properties for defining a DBInstance.

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

Initializer 

import { DBInstanceProps } from '@alicloud/ros-cdk-gpdb'
const dBInstanceProps: DBInstanceProps = { ... }

Properties

Name Type Description
engineVersion string | @alicloud/ros-cdk-core.IResolvable Property engineVersion: The version of the database engine.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The vSwitch ID of the instance.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone ID of the instance, such as cn-hangzhou-d.
createSampleData boolean | @alicloud/ros-cdk-core.IResolvable Property createSampleData: Whether to load the sample data set after the instance is created.
dbInstanceCategory string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceCategory: DB instance category, valid values: Basic, HighAvailability.
dbInstanceClass string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceClass: The instance type.
dbInstanceDescription string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceDescription: The description of the instance.
dbInstanceGroupCount number | @alicloud/ros-cdk-core.IResolvable Property dbInstanceGroupCount: The number of compute nodes in the instance.
dbInstanceMode string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceMode: The db instance mode.
encryptionKey string | @alicloud/ros-cdk-core.IResolvable 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 string | @alicloud/ros-cdk-core.IResolvable Property encryptionType: The type of the encryption.
idleTime number | @alicloud/ros-cdk-core.IResolvable Property idleTime: Idle release wait time.
instanceSpec string | @alicloud/ros-cdk-core.IResolvable Property instanceSpec: The specification of segment nodes.
masterNodeNum number | @alicloud/ros-cdk-core.IResolvable Property masterNodeNum: The number of master nodes.
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The billing method of the instance.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The subscription period.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: Unit of subscription period, it could be Month\/Year.
privateIpAddress string | @alicloud/ros-cdk-core.IResolvable Property privateIpAddress: Private IP address.
prodType string | @alicloud/ros-cdk-core.IResolvable Property prodType: Prod type.
securityIpList string | @alicloud/ros-cdk-core.IResolvable Property securityIpList: The whitelist of IP addresses that are allowed to access the instance.
segDiskPerformanceLevel string | @alicloud/ros-cdk-core.IResolvable Property segDiskPerformanceLevel: Seg disk performance level.
segNodeNum number | @alicloud/ros-cdk-core.IResolvable Property segNodeNum: Calculate the number of nodes.
segStorageType string | @alicloud/ros-cdk-core.IResolvable Property segStorageType: The disk type of segment nodes.
serverlessMode string | @alicloud/ros-cdk-core.IResolvable Property serverlessMode: Mode of the Serverless instance.
serverlessResource number | @alicloud/ros-cdk-core.IResolvable Property serverlessResource: Computing resource threshold.
storageSize number | @alicloud/ros-cdk-core.IResolvable 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 string | @alicloud/ros-cdk-core.IResolvable Property vectorConfigurationStatus: the status of vector configuration.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The VPC ID of the instance.

engineVersionRequired 

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

Property engineVersion: The version of the database engine.

For example: 6.0、7.0

vSwitchIdRequired 

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

Property vSwitchId: The vSwitch ID of the instance.

zoneIdRequired 

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

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.

createSampleDataOptional 

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

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

dbInstanceCategoryOptional 

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

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

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

dbInstanceClassOptional 

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

Property dbInstanceClass: The instance type.

dbInstanceDescriptionOptional 

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

Property dbInstanceDescription: The description of the instance.

The description cannot exceed 256 characters in length.

dbInstanceGroupCountOptional 

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

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.

dbInstanceModeOptional 

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

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.

encryptionKeyOptional 

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

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.

encryptionTypeOptional 

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

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.

idleTimeOptional 

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

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.

instanceSpecOptional 

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

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.

masterNodeNumOptional 

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

Property masterNodeNum: The number of master nodes.

Minimum is 1, max is 2.

payTypeOptional 

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

Property payType: The billing method of the instance.

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

periodOptional 

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

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.

periodUnitOptional 

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

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

Default value is Month.

privateIpAddressOptional 

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

Property privateIpAddress: Private IP address.

prodTypeOptional 

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

Property prodType: Prod type.

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

securityIpListOptional 

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

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

Default value: 127.0.0.1.

segDiskPerformanceLevelOptional 

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

Property segDiskPerformanceLevel: Seg disk performance level.

The value can be: pl0、pl1 and pl2

segNodeNumOptional 

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

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.

segStorageTypeOptional 

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

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.

serverlessModeOptional 

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

Property serverlessMode: Mode of the Serverless instance.

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

serverlessResourceOptional 

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

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.

storageSizeOptional 

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

Property storageSize: The storage capacity of per segment node.

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

tagsOptional 

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

vectorConfigurationStatusOptional 

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

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).

vpcIdOptional 

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

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.