DrdsInstance

This class encapsulates and extends the ROS resource type DATASOURCE::DRDS::DrdsInstance, which is used to query the information about a PolarDB-X 1.0 instance.

Initializers

import com.aliyun.ros.cdk.drds.datasource.DrdsInstance;
DrdsInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .drdsInstanceId(java.lang.String)
    .drdsInstanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
drdsInstanceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property drdsInstanceId: The ID of the Drds instance.
refreshOptions	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

drdsInstanceId^Required

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

Property drdsInstanceId: The ID of the Drds instance.

---

refreshOptions^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

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.drds.datasource.DrdsInstance;
DrdsInstance.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.
attrCommodityCode	com.aliyun.ros.cdk.core.IResolvable	Attribute CommodityCode: The commodity code of the service.
attrCreateTime	com.aliyun.ros.cdk.core.IResolvable	Attribute CreateTime: The timestamp that indicates when the instance is created.
attrDescription	com.aliyun.ros.cdk.core.IResolvable	Attribute Description: The description of the instance.
attrDrdsInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute DrdsInstanceId: The ID of the Drds instance.
attrExpireDate	com.aliyun.ros.cdk.core.IResolvable	Attribute ExpireDate: The timestamp that indicates when the instance expires.
attrInstanceSeries	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceSeries: The edition of the instance.
attrInstanceSpec	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceSpec: The specification of the instance.
attrInstRole	com.aliyun.ros.cdk.core.IResolvable	Attribute InstRole: The role of the instance.
attrLabel	com.aliyun.ros.cdk.core.IResolvable	Attribute Label: The tag of the instance.
attrMachineType	com.aliyun.ros.cdk.core.IResolvable	Attribute MachineType: The machine type of the instance.
attrMasterInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute MasterInstanceId: The ID of the primary instance.
attrMysqlVersion	com.aliyun.ros.cdk.core.IResolvable	Attribute MysqlVersion: Engine version.
attrNetworkType	com.aliyun.ros.cdk.core.IResolvable	Attribute NetworkType: The network type of the instance.
attrOrderInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute OrderInstanceId: The ID of the purchased instance.
attrReadOnlyDbInstanceIds	com.aliyun.ros.cdk.core.IResolvable	Attribute ReadOnlyDBInstanceIds: The IDs of read-only instances that are associated with the instance.
attrResourceGroupId	com.aliyun.ros.cdk.core.IResolvable	Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attrStorageType	com.aliyun.ros.cdk.core.IResolvable	Attribute StorageType: The storage type of the Drds database.
attrType	com.aliyun.ros.cdk.core.IResolvable	Attribute Type: The type of the instance.
attrVersion	com.aliyun.ros.cdk.core.IResolvable	Attribute Version: The version of the instance.
attrVersionAction	com.aliyun.ros.cdk.core.IResolvable	Attribute VersionAction: Indicates whether the version of the instance can be upgraded.
attrVips	com.aliyun.ros.cdk.core.IResolvable	Attribute Vips: The list of returned virtual IP addresses (VIPs).
attrVpcCloudInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute VpcCloudInstanceId: The ID of the instance that is deployed in the VPC.
attrZoneId	com.aliyun.ros.cdk.core.IResolvable	Attribute ZoneId: The ID of the zone in which the resource is located.

---

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

---

attrCommodityCode^Required

public IResolvable getAttrCommodityCode();

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

Attribute CommodityCode: The commodity code of the service.

---

attrCreateTime^Required

public IResolvable getAttrCreateTime();

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

Attribute CreateTime: The timestamp that indicates when the instance is created.

---

attrDescription^Required

public IResolvable getAttrDescription();

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

Attribute Description: The description of the instance.

---

attrDrdsInstanceId^Required

public IResolvable getAttrDrdsInstanceId();

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

Attribute DrdsInstanceId: The ID of the Drds instance.

---

attrExpireDate^Required

public IResolvable getAttrExpireDate();

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

Attribute ExpireDate: The timestamp that indicates when the instance expires.

---

attrInstanceSeries^Required

public IResolvable getAttrInstanceSeries();

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

Attribute InstanceSeries: The edition of the instance.

Valid values: starter: Starter Edition enterprise: Enterprise Edition standard: Standard Edition

---

attrInstanceSpec^Required

public IResolvable getAttrInstanceSpec();

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

Attribute InstanceSpec: The specification of the instance.

---

attrInstRole^Required

public IResolvable getAttrInstRole();

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

Attribute InstRole: The role of the instance.

Valid values: MASTER: The instance is a primary instance. SLAVE: The instance is a read-only instance to analyze complex queries. SLAVE_FLOW: The instance is a read-only instance for high-concurrency scenarios.

---

attrLabel^Required

public IResolvable getAttrLabel();

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

Attribute Label: The tag of the instance.

Valid values: NORMAL: The instance is a standard instance. HA: The instance is a high-availability (HA) instance. VPC: The instance is a VPC-based instance.

---

attrMachineType^Required

public IResolvable getAttrMachineType();

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

Attribute MachineType: The machine type of the instance.

Valid value: ecs.

---

attrMasterInstanceId^Required

public IResolvable getAttrMasterInstanceId();

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

Attribute MasterInstanceId: The ID of the primary instance.

---

attrMysqlVersion^Required

public IResolvable getAttrMysqlVersion();

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

Attribute MysqlVersion: Engine version.

---

attrNetworkType^Required

public IResolvable getAttrNetworkType();

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

Attribute NetworkType: The network type of the instance.

Valid values: CLASSIC VPC

---

attrOrderInstanceId^Required

public IResolvable getAttrOrderInstanceId();

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

Attribute OrderInstanceId: The ID of the purchased instance.

---

attrReadOnlyDbInstanceIds^Required

public IResolvable getAttrReadOnlyDbInstanceIds();

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

Attribute ReadOnlyDBInstanceIds: The IDs of read-only instances that are associated with the instance.

---

attrResourceGroupId^Required

public IResolvable getAttrResourceGroupId();

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

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.

---

attrStorageType^Required

public IResolvable getAttrStorageType();

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

Attribute StorageType: The storage type of the Drds database.

Valid values: RDS PolarDB

---

attrType^Required

public IResolvable getAttrType();

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

Attribute Type: The type of the instance.

Valid values: PUBLIC: The returned instance is a shared instance. PRIVATE: The returned instance is a dedicated instance.

---

attrVersion^Required

public IResolvable getAttrVersion();

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

Attribute Version: The version of the instance.

---

attrVersionAction^Required

public IResolvable getAttrVersionAction();

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

Attribute VersionAction: Indicates whether the version of the instance can be upgraded.

---

attrVips^Required

public IResolvable getAttrVips();

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

Attribute Vips: The list of returned virtual IP addresses (VIPs).

---

attrVpcCloudInstanceId^Required

public IResolvable getAttrVpcCloudInstanceId();

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

Attribute VpcCloudInstanceId: The ID of the instance that is deployed in the VPC.

---

attrZoneId^Required

public IResolvable getAttrZoneId();

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

Attribute ZoneId: The ID of the zone in which the resource is located.

---