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

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

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.

aiNodeSpecInfos^Optional

public readonly aiNodeSpecInfos: IResolvable | IResolvable | AINodeSpecInfosProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AINodeSpecInfosProperty[]

Property aiNodeSpecInfos: AI node spec infos.

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.

cacheStorageSize^Optional

public readonly cacheStorageSize: string | IResolvable;

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

Property cacheStorageSize: The cache size for a serverless instance, in GB.

createSampleData^Optional

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

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.

dbInstanceClass^Optional

public readonly dbInstanceClass: string | IResolvable;

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

Property dbInstanceClass: The instance type.

For more information, see the description of the DBInstanceClass parameter.

This parameter is required for instances in reserved 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.

dbInstanceGroupCount^Optional

public readonly dbInstanceGroupCount: number | IResolvable;

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

Property dbInstanceGroupCount: The number of compute groups.

Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, and 128.

This parameter is required for instances in reserved storage mode.

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.

deployMode^Optional

public readonly deployMode: string | IResolvable;

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

Property deployMode: The deployment mode.

Valid values: - multiple: multi-AZ deployment. - single: single-AZ deployment.

• If this parameter is not specified, the default value is single.

• Defaults to single (single-AZ deployment), which is the only mode currently supported.

enableSsl^Optional

public readonly enableSsl: boolean | IResolvable;

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

Property enableSsl: Whether to enable SSL encryption.

Valid values: true: Enable SSL encryption. false (default): Do not enable SSL encryption.

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.

idleTime^Optional

public readonly idleTime: number | IResolvable;

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

Property idleTime: The period of inactivity, in seconds, after which the instance is considered idle.

Minimum value: 60. Default value: 600.

This parameter is required only for serverless instances that use auto-scheduling.

instanceSpec^Optional

public readonly instanceSpec: string | IResolvable;

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

Property instanceSpec: The instance type for the compute nodes.

Valid values for a High-availability Edition instance in elastic storage mode: - 2C16G - 4C32G - 16C128G Valid values for a Basic Edition instance in elastic storage mode: - 2C8G - 4C16G - 8C32G - 16C64G Valid values for a serverless instance: - 4C16G - 8C32G

This parameter is required for instances in elastic storage mode or serverless mode.

masterAiSpec^Optional

public readonly masterAiSpec: string | IResolvable;

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

Property masterAiSpec: If you need to change the Master node to MasterAI node, specify this parameter.

This parameter cannot be specified at the same time as MasterCU. Only some regions and availability zones support changing the Master node to MasterAI node. Only Basic edition instances of AnalyticDB PostgreSQL 7.0 support MasterAI nodes. You can query all possible values of this parameter on the Master node reconfiguration sales page.

masterCu^Optional

public readonly masterCu: number | IResolvable;

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

Property masterCu: The resources for the coordinator node.

Valid values: - 2 CU - 4 CU - 8 CU - 16 CU - 32 CU

You are charged for coordinator node resources of 8 CUs or more.

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.

prodType^Optional

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.

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

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

Property resourceGroupId: The ID of the resource group.

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.

segDiskPerformanceLevel^Optional

public readonly segDiskPerformanceLevel: string | IResolvable;

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

Property segDiskPerformanceLevel: The performance level of the ESSDs.

Valid values: - pl0: PL0 - pl1: PL1 - pl2: PL2

• This parameter applies only if the segment node storage type is ESSD.

• If this parameter is not specified, pl1 is used by default.

segNodeNum^Optional

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.

segStorageType^Optional

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.

serverlessMode^Optional

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.

serverlessResource^Optional

public readonly serverlessResource: number | IResolvable;

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

Property serverlessResource: The threshold for computing resources, in AnalyticDB Compute Units (ACUs).

The value must be a multiple of 8, ranging from 8 to 32. The default value is 32.

This parameter is required only for serverless instances that use auto-scheduling.

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.

standbyVSwitchId^Optional

public readonly standbyVSwitchId: string | IResolvable;

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

Property standbyVSwitchId: The ID of the vSwitch in the standby zone.

• This parameter is required only for a multi-AZ deployment.

• The vSwitch must be in the standby zone specified in StandbyZoneId.

standbyZoneId^Optional

public readonly standbyZoneId: string | IResolvable;

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

Property standbyZoneId: The ID of the standby zone.

• This parameter is required only for a multi-AZ deployment.

• You can call the DescribeRegions operation to query the IDs of available zones.

• The standby zone must be different from the primary zone.

storageSize^Optional

public readonly storageSize: number | IResolvable;

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

Property storageSize: The storage capacity for the instance, in GB.

Valid values: .

This parameter is required for instances in elastic storage mode.

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.

vectorConfigurationStatus^Optional

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

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.