DBInstance

• Implements: IDBInstance

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

Initializers

import com.aliyun.ros.cdk.gpdb.DBInstance;
DBInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .engineVersion(java.lang.String)
    .engineVersion(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .aiNodeSpecInfos(IResolvable)
//  .aiNodeSpecInfos(java.util.List<IResolvable)
//  .aiNodeSpecInfos(AINodeSpecInfosProperty>)
//  .backupId(java.lang.String)
//  .backupId(IResolvable)
//  .cacheStorageSize(java.lang.String)
//  .cacheStorageSize(IResolvable)
//  .createSampleData(java.lang.Boolean)
//  .createSampleData(IResolvable)
//  .dbInstanceCategory(java.lang.String)
//  .dbInstanceCategory(IResolvable)
//  .dbInstanceClass(java.lang.String)
//  .dbInstanceClass(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .dbInstanceGroupCount(java.lang.Number)
//  .dbInstanceGroupCount(IResolvable)
//  .dbInstanceMode(java.lang.String)
//  .dbInstanceMode(IResolvable)
//  .deployMode(java.lang.String)
//  .deployMode(IResolvable)
//  .enableSsl(java.lang.Boolean)
//  .enableSsl(IResolvable)
//  .encryptionKey(java.lang.String)
//  .encryptionKey(IResolvable)
//  .encryptionType(java.lang.String)
//  .encryptionType(IResolvable)
//  .idleTime(java.lang.Number)
//  .idleTime(IResolvable)
//  .instanceSpec(java.lang.String)
//  .instanceSpec(IResolvable)
//  .masterAiSpec(java.lang.String)
//  .masterAiSpec(IResolvable)
//  .masterCu(java.lang.Number)
//  .masterCu(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)
//  .prodType(java.lang.String)
//  .prodType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityIpList(java.lang.String)
//  .securityIpList(IResolvable)
//  .segDiskPerformanceLevel(java.lang.String)
//  .segDiskPerformanceLevel(IResolvable)
//  .segNodeNum(java.lang.Number)
//  .segNodeNum(IResolvable)
//  .segStorageType(java.lang.String)
//  .segStorageType(IResolvable)
//  .serverlessMode(java.lang.String)
//  .serverlessMode(IResolvable)
//  .serverlessResource(java.lang.Number)
//  .serverlessResource(IResolvable)
//  .srcDbInstanceName(java.lang.String)
//  .srcDbInstanceName(IResolvable)
//  .standbyVSwitchId(java.lang.String)
//  .standbyVSwitchId(IResolvable)
//  .standbyZoneId(java.lang.String)
//  .standbyZoneId(IResolvable)
//  .storageSize(java.lang.Number)
//  .storageSize(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vectorConfigurationStatus(java.lang.String)
//  .vectorConfigurationStatus(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

engineVersion^Required

• 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

vSwitchId^Required

• Type: java.lang.String OR com.aliyun.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

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

aiNodeSpecInfos^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAINodeSpecInfosProperty>

Property aiNodeSpecInfos: AI node spec infos.

backupId^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

createSampleData^Optional

• Type: java.lang.Boolean OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

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

dbInstanceGroupCount^Optional

• Type: java.lang.Number OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.

deployMode^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.Boolean OR com.aliyun.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

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

encryptionType^Optional

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

idleTime^Optional

• Type: java.lang.Number OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.Number OR com.aliyun.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

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property masterNodeNum: The number of master nodes.

Minimum is 1, max is 2.

payType^Optional

• 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

period^Optional

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

periodUnit^Optional

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

privateIpAddress^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property privateIpAddress: This parameter is deprecated.

prodType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property prodType: Prod type.

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

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

securityIpList^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.Number OR com.aliyun.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

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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.Number OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.Number OR com.aliyun.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: java.util.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.

vectorConfigurationStatus^Optional

• Type: java.lang.String OR com.aliyun.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

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

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.gpdb.DBInstance;
DBInstance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrArn^Required

public java.lang.Object getAttrArn();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrConnectionString^Required

public java.lang.Object getAttrConnectionString();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionString: The endpoint of the instance.

attrDbInstanceId^Required

public java.lang.Object getAttrDbInstanceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DBInstanceId: The ID of the instance.

attrOrderId^Required

public java.lang.Object getAttrOrderId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The order ID of the instance.

attrPort^Required

public java.lang.Object getAttrPort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public DBInstanceProps getProps();

• Type: DBInstanceProps