Skip to content

ElasticDBInstanceProps

Properties for defining a ElasticDBInstance.

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

Initializer 

import com.aliyun.ros.cdk.gpdb.ElasticDBInstanceProps;
ElasticDBInstanceProps.builder()
    .engineVersion(java.lang.String)
    .engineVersion(IResolvable)
    .instanceSpec(java.lang.String)
    .instanceSpec(IResolvable)
    .segNodeNum(java.lang.Number)
    .segNodeNum(IResolvable)
    .segStorageType(java.lang.String)
    .segStorageType(IResolvable)
    .storageSize(java.lang.Number)
    .storageSize(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .dbInstanceCategory(java.lang.String)
//  .dbInstanceCategory(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .dbInstanceMode(java.lang.String)
//  .dbInstanceMode(IResolvable)
//  .encryptionKey(java.lang.String)
//  .encryptionKey(IResolvable)
//  .encryptionType(java.lang.String)
//  .encryptionType(IResolvable)
//  .masterNodeNum(java.lang.Number)
//  .masterNodeNum(IResolvable)
//  .payType(java.lang.String)
//  .payType(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .privateIpAddress(java.lang.String)
//  .privateIpAddress(IResolvable)
//  .securityIpList(java.lang.String)
//  .securityIpList(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
    .build();

Properties

Name Type Description
engineVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property engineVersion: The version of the database engine.
instanceSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceSpec: The specification of segment nodes.
segNodeNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property segNodeNum: The number of segment nodes.
segStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property segStorageType: The disk type of segment nodes.
storageSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property storageSize: The storage capacity of per segment node.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The vSwitch ID of the instance.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone ID of the instance, such as cn-hangzhou-d.
dbInstanceCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceCategory: DB instance category, valid values: Basic, HighAvailability.
dbInstanceDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceDescription: The description of the instance.
dbInstanceMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceMode: The db instance mode.
encryptionKey java.lang.String OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property encryptionType: The type of the encryption.
masterNodeNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property masterNodeNum: The number of master nodes.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: The billing method of the instance.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription period.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: Unit of subscription period, it could be Month\/Year.
privateIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property privateIpAddress: Private IP address.
securityIpList java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityIpList: The whitelist of IP addresses that are allowed to access the instance.
tags java.util.List<TagsProperty> Property tags: The list of instance tags in the form of key\/value pairs.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The VPC ID of the instance.

engineVersionRequired 

public java.lang.Object getEngineVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property engineVersion: The version of the database engine.

For example: 6.0、7.0

instanceSpecRequired 

public java.lang.Object getInstanceSpec();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceSpec: The specification of segment nodes.

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

segNodeNumRequired 

public java.lang.Object getSegNodeNum();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getSegStorageType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property segStorageType: The disk type of segment nodes.

For example: cloud_essd, cloud_efficiency.

storageSizeRequired 

public java.lang.Object getStorageSize();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The vSwitch ID of the instance.

zoneIdRequired 

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDbInstanceCategory();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDbInstanceDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceDescription: The description of the instance.

The description cannot exceed 256 characters in length.

dbInstanceModeOptional 

public java.lang.Object getDbInstanceMode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.

encryptionKeyOptional 

public java.lang.Object getEncryptionKey();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getEncryptionType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getMasterNodeNum();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property masterNodeNum: The number of master nodes.

Minimum is 1, max is 2.

payTypeOptional 

public java.lang.Object getPayType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getPeriodUnit();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Default value is Month.

privateIpAddressOptional 

public java.lang.Object getPrivateIpAddress();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property privateIpAddress: Private IP address.

securityIpListOptional 

public java.lang.Object getSecurityIpList();
  • Type: java.lang.String OR com.aliyun.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 java.util.List<TagsProperty> getTags();

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 java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.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.