Skip to content

ElasticDBInstanceProps

Properties for defining a ElasticDBInstance.

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

Initializer 

import ros_cdk_gpdb
ros_cdk_gpdb.ElasticDBInstanceProps(
  engine_version: typing.Union[str, IResolvable],
  instance_spec: typing.Union[str, IResolvable],
  seg_node_num: typing.Union[typing.Union[int, float], IResolvable],
  seg_storage_type: typing.Union[str, IResolvable],
  storage_size: typing.Union[typing.Union[int, float], IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  db_instance_category: typing.Union[str, IResolvable] = None,
  db_instance_description: typing.Union[str, IResolvable] = None,
  db_instance_mode: typing.Union[str, IResolvable] = None,
  encryption_key: typing.Union[str, IResolvable] = None,
  encryption_type: typing.Union[str, IResolvable] = None,
  master_node_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  private_ip_address: typing.Union[str, IResolvable] = None,
  security_ip_list: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
engine_version typing.Union[str, ros_cdk_core.IResolvable] Property engineVersion: The version of the database engine.
instance_spec typing.Union[str, ros_cdk_core.IResolvable] Property instanceSpec: The specification of segment nodes.
seg_node_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property segNodeNum: The number of segment nodes.
seg_storage_type typing.Union[str, ros_cdk_core.IResolvable] Property segStorageType: The disk type of segment nodes.
storage_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property storageSize: The storage capacity of per segment node.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The vSwitch ID of the instance.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone ID of the instance, such as cn-hangzhou-d.
db_instance_category typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceCategory: DB instance category, valid values: Basic, HighAvailability.
db_instance_description typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceDescription: The description of the instance.
db_instance_mode typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceMode: The db instance mode.
encryption_key typing.Union[str, 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.
encryption_type typing.Union[str, ros_cdk_core.IResolvable] Property encryptionType: The type of the encryption.
master_node_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property masterNodeNum: The number of master nodes.
pay_type typing.Union[str, ros_cdk_core.IResolvable] Property payType: The billing method of the instance.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The subscription period.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: Unit of subscription period, it could be Month\/Year.
private_ip_address typing.Union[str, ros_cdk_core.IResolvable] Property privateIpAddress: Private IP address.
security_ip_list typing.Union[str, ros_cdk_core.IResolvable] Property securityIpList: The whitelist of IP addresses that are allowed to access the instance.
tags typing.List[TagsProperty] Property tags: The list of instance tags in the form of key\/value pairs.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The VPC ID of the instance.

engine_versionRequired 

engine_version: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property engineVersion: The version of the database engine.

For example: 6.0、7.0

instance_specRequired 

instance_spec: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceSpec: The specification of segment nodes.

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

seg_node_numRequired 

seg_node_num: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

seg_storage_typeRequired 

seg_storage_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property segStorageType: The disk type of segment nodes.

For example: cloud_essd, cloud_efficiency.

storage_sizeRequired 

storage_size: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property storageSize: The storage capacity of per segment node.

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

v_switch_idRequired 

v_switch_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vSwitchId: The vSwitch ID of the instance.

zone_idRequired 

zone_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

db_instance_categoryOptional 

db_instance_category: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

db_instance_descriptionOptional 

db_instance_description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbInstanceDescription: The description of the instance.

The description cannot exceed 256 characters in length.

db_instance_modeOptional 

db_instance_mode: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.

encryption_keyOptional 

encryption_key: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

encryption_typeOptional 

encryption_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

master_node_numOptional 

master_node_num: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property masterNodeNum: The number of master nodes.

Minimum is 1, max is 2.

pay_typeOptional 

pay_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 

period: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

period_unitOptional 

period_unit: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

Default value is Month.

private_ip_addressOptional 

private_ip_address: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property privateIpAddress: Private IP address.

security_ip_listOptional 

security_ip_list: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 

tags: typing.List[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.

vpc_idOptional 

vpc_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.