Skip to content

DBInstanceProps

Properties for defining a DBInstance.

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

Initializer 

import ros_cdk_gpdb
ros_cdk_gpdb.DBInstanceProps(
  engine_version: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  create_sample_data: typing.Union[bool, IResolvable] = None,
  db_instance_category: typing.Union[str, IResolvable] = None,
  db_instance_class: typing.Union[str, IResolvable] = None,
  db_instance_description: typing.Union[str, IResolvable] = None,
  db_instance_group_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  db_instance_mode: typing.Union[str, IResolvable] = None,
  encryption_key: typing.Union[str, IResolvable] = None,
  encryption_type: typing.Union[str, IResolvable] = None,
  idle_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  instance_spec: 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,
  prod_type: typing.Union[str, IResolvable] = None,
  security_ip_list: typing.Union[str, IResolvable] = None,
  seg_disk_performance_level: typing.Union[str, IResolvable] = None,
  seg_node_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  seg_storage_type: typing.Union[str, IResolvable] = None,
  serverless_mode: typing.Union[str, IResolvable] = None,
  serverless_resource: typing.Union[typing.Union[int, float], IResolvable] = None,
  storage_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vector_configuration_status: typing.Union[str, IResolvable] = 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.
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.
create_sample_data typing.Union[bool, ros_cdk_core.IResolvable] Property createSampleData: Whether to load the sample data set after the instance is created.
db_instance_category typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceCategory: DB instance category, valid values: Basic, HighAvailability.
db_instance_class typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceClass: The instance type.
db_instance_description typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceDescription: The description of the instance.
db_instance_group_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property dbInstanceGroupCount: The number of compute nodes in 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.
idle_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property idleTime: Idle release wait time.
instance_spec typing.Union[str, ros_cdk_core.IResolvable] Property instanceSpec: The specification of segment nodes.
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.
prod_type typing.Union[str, ros_cdk_core.IResolvable] Property prodType: Prod type.
security_ip_list typing.Union[str, ros_cdk_core.IResolvable] Property securityIpList: The whitelist of IP addresses that are allowed to access the instance.
seg_disk_performance_level typing.Union[str, ros_cdk_core.IResolvable] Property segDiskPerformanceLevel: Seg disk performance level.
seg_node_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property segNodeNum: Calculate the number of nodes.
seg_storage_type typing.Union[str, ros_cdk_core.IResolvable] Property segStorageType: The disk type of segment nodes.
serverless_mode typing.Union[str, ros_cdk_core.IResolvable] Property serverlessMode: Mode of the Serverless instance.
serverless_resource typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property serverlessResource: Computing resource threshold.
storage_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property storageSize: The storage capacity of per segment node.
tags typing.List[TagsProperty] Property tags: The list of instance tags in the form of key\/value pairs.
vector_configuration_status typing.Union[str, ros_cdk_core.IResolvable] Property vectorConfigurationStatus: the status of vector configuration.
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

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.

create_sample_dataOptional 

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

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_classOptional 

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

Property dbInstanceClass: The instance type.

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_group_countOptional 

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

Property dbInstanceGroupCount: The number of compute nodes in the instance.

The value can be 2, 4, 8, 12, 16, 24, 32, 64, 96, or 128.

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.

idle_timeOptional 

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

Property idleTime: Idle release wait time.

That is, when the period of no service traffic reaches the specified period, the instance becomes idle. The unit is second. The minimum value is 60. The default value is 600.

instance_specOptional 

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

Property instanceSpec: The specification of segment nodes.

  • When DBInstanceCategory is HighAvailability, Valid values: 2C16G, 4C32G, 8C64G, 16C128G.
  • When DBInstanceCategory is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When DBInstanceCategory is Serverless, Valid values: 4C16G, 8C32G. This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

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.

prod_typeOptional 

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

Property prodType: Prod type.

The value can be: standard, cost-effective. The default value is standard.

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.

seg_disk_performance_levelOptional 

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

Property segDiskPerformanceLevel: Seg disk performance level.

The value can be: pl0、pl1 and pl2

seg_node_numOptional 

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

seg_storage_typeOptional 

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. This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

serverless_modeOptional 

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

serverless_resourceOptional 

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

Property serverlessResource: Computing resource threshold.

The value ranges from 8 to 32. The step length is 8. The unit is ACU. The default value is 32.

storage_sizeOptional 

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.

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.

vector_configuration_statusOptional 

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

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.