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

engineVersion^Required

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

instanceSpec^Required

public readonly instanceSpec: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceSpec: The specification of segment nodes.

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

segNodeNum^Required

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.

segStorageType^Required

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.

storageSize^Required

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.

vSwitchId^Required

public readonly vSwitchId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The vSwitch ID.

• This parameter is required.

• The vSwitch must be in the zone specified by ZoneId.

zoneId^Required

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.

backupId^Optional

public readonly backupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property backupId: Backup set ID.

You can call DescribeDataBackups to view the backup set IDs of all backup sets under the target instance.

dbInstanceCategory^Optional

public readonly dbInstanceCategory: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceCategory: The instance edition.

Valid values: - HighAvailability: High-availability Edition - Basic: Basic Edition

This parameter is required for instances in elastic storage mode.

dbInstanceDescription^Optional

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.

dbInstanceMode^Optional

public readonly dbInstanceMode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.

encryptionKey^Optional

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.

encryptionType^Optional

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.

masterNodeNum^Optional

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.

payType^Optional

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

period^Optional

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.

periodUnit^Optional

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.

privateIpAddress^Optional

public readonly privateIpAddress: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property privateIpAddress: This parameter is deprecated.

securityIpList^Optional

public readonly securityIpList: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property securityIpList: The IP address whitelist for the instance.

A value of 127.0.0.1 blocks all external access. After you create the instance, you can call the ModifySecurityIps operation to modify the IP address whitelist.

srcDbInstanceName^Optional

public readonly srcDbInstanceName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property srcDbInstanceName: Clone source instance ID.

You can call the DescribeDBInstances interface to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

tags^Optional

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

vpcId^Optional

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.