DBInstance

• Implements: IDBInstance

This class encapsulates and extends the ROS resource type ALIYUN::GPDB::DBInstance.

Initializers

import ros_cdk_gpdb
ros_cdk_gpdb.DBInstance(
  scope: Construct,
  id: str,
  engine_version: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  ai_node_spec_infos: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AINodeSpecInfosProperty]]] = None,
  backup_id: typing.Union[str, IResolvable] = None,
  cache_storage_size: typing.Union[str, IResolvable] = None,
  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,
  deploy_mode: typing.Union[str, IResolvable] = None,
  enable_ssl: typing.Union[bool, 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_ai_spec: typing.Union[str, IResolvable] = None,
  master_cu: typing.Union[typing.Union[int, float], 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,
  resource_group_id: 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,
  src_db_instance_name: typing.Union[str, IResolvable] = None,
  standby_v_switch_id: typing.Union[str, IResolvable] = None,
  standby_zone_id: typing.Union[str, 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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

engine_version^Required

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

Property engineVersion: The version of the database engine.

For example: 6.0、7.0

v_switch_id^Required

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

Property vSwitchId: The vSwitch ID.

• This parameter is required.
• The vSwitch must be in the zone specified by ZoneId.

zone_id^Required

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

ai_node_spec_infos^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AINodeSpecInfosProperty]]]

Property aiNodeSpecInfos: AI node spec infos.

backup_id^Optional

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

cache_storage_size^Optional

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

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

create_sample_data^Optional

• 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_category^Optional

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

db_instance_class^Optional

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

db_instance_description^Optional

• 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_count^Optional

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

db_instance_mode^Optional

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

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.

deploy_mode^Optional

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

enable_ssl^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableSsl: Whether to enable SSL encryption.

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

encryption_key^Optional

• 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_type^Optional

• 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_time^Optional

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

instance_spec^Optional

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

master_ai_spec^Optional

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

master_cu^Optional

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

master_node_num^Optional

• 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_type^Optional

• 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

period^Optional

• 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_unit^Optional

• 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_address^Optional

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

Property privateIpAddress: This parameter is deprecated.

prod_type^Optional

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

Property prodType: Prod type.

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

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

security_ip_list^Optional

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

seg_disk_performance_level^Optional

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

seg_node_num^Optional

• 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_type^Optional

• 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_mode^Optional

• 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_resource^Optional

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

src_db_instance_name^Optional

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

standby_v_switch_id^Optional

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

standby_zone_id^Optional

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

storage_size^Optional

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

• Type: 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_status^Optional

• 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_id^Optional

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

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_gpdb
ros_cdk_gpdb.DBInstance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_arn^Required

attr_arn: typing.Union[str, IResolvable]

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attr_connection_string^Required

attr_connection_string: typing.Union[str, IResolvable]

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

Attribute ConnectionString: The endpoint of the instance.

attr_db_instance_id^Required

attr_db_instance_id: typing.Union[str, IResolvable]

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

Attribute DBInstanceId: The ID of the instance.

attr_order_id^Required

attr_order_id: typing.Union[str, IResolvable]

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

Attribute OrderId: The order ID of the instance.

attr_port^Required

attr_port: typing.Union[str, IResolvable]

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

Attribute Port: The port used to connect to the instance.

props^Required

props: DBInstanceProps

• Type: DBInstanceProps