ElasticDBInstance

This class encapsulates and extends the ROS resource type ALIYUN::GPDB::ElasticDBInstance, which is used to create an AnalyticDB for PostgreSQL instance in elastic storage mode.

Initializers

import com.aliyun.ros.cdk.gpdb.ElasticDBInstance;
ElasticDBInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No 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.

---

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

---

instanceSpec^Required

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

Property instanceSpec: The specification of segment nodes.

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

---

segNodeNum^Required

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

---

segStorageType^Required

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

---

storageSize^Required

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

---

vSwitchId^Required

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

Property vSwitchId: The vSwitch ID of the instance.

---

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.

---

dbInstanceCategory^Optional

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

---

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.

---

dbInstanceMode^Optional

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

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.

---

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.

---

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: Private IP address.

---

securityIpList^Optional

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

---

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.

---

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

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

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

---

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

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrConnectionString	com.aliyun.ros.cdk.core.IResolvable	Attribute ConnectionString: The endpoint of the instance.
attrDbInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceId: The ID of the instance.
attrOrderId	com.aliyun.ros.cdk.core.IResolvable	Attribute OrderId: The order ID of the instance.
attrPort	com.aliyun.ros.cdk.core.IResolvable	Attribute Port: The port used to connect to the instance.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

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

---

attrConnectionString^Required

public IResolvable getAttrConnectionString();

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

Attribute ConnectionString: The endpoint of the instance.

---

attrDbInstanceId^Required

public IResolvable getAttrDbInstanceId();

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

Attribute DBInstanceId: The ID of the instance.

---

attrOrderId^Required

public IResolvable getAttrOrderId();

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

Attribute OrderId: The order ID of the instance.

---

attrPort^Required

public IResolvable getAttrPort();

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

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

---