Skip to content

ElasticDBInstanceProps

Properties for defining a ElasticDBInstance.

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

Initializer 

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

Properties

Name Type Description
engineVersion string | @alicloud/ros-cdk-core.IResolvable Property engineVersion: The version of the database engine.
instanceSpec string | @alicloud/ros-cdk-core.IResolvable Property instanceSpec: The specification of segment nodes.
segNodeNum number | @alicloud/ros-cdk-core.IResolvable Property segNodeNum: The number of segment nodes.
segStorageType string | @alicloud/ros-cdk-core.IResolvable Property segStorageType: The disk type of segment nodes.
storageSize number | @alicloud/ros-cdk-core.IResolvable Property storageSize: The storage capacity of per segment node.
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.
dbInstanceCategory string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceCategory: DB instance category, valid values: Basic, HighAvailability.
dbInstanceDescription string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceDescription: The description of 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.
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.
securityIpList string | @alicloud/ros-cdk-core.IResolvable Property securityIpList: The whitelist of IP addresses that are allowed to access the instance.
tags TagsProperty[] Property tags: The list of instance tags in the form of key\/value pairs.
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

instanceSpecRequired 

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

Property instanceSpec: The specification of segment nodes.

For example: 2C16G, 4C32G, 16C128G.

segNodeNumRequired 

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

Property segNodeNum: The number of segment nodes.

For the high availability version, the value ranges from 4 to 512. The basic version ranges from 2 to 512.

segStorageTypeRequired 

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.

storageSizeRequired 

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.

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.

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.

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.

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.

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.

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.

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.

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.