InstanceClasses

This class encapsulates and extends the ROS resource type DATASOURCE::REDIS::InstanceClasses, which is used to query the types of ApsaraDB for Redis instances.

Initializers

import com.aliyun.ros.cdk.redis.datasource.InstanceClasses;
InstanceClasses.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .acceptLanguage(java.lang.String)
//  .acceptLanguage(IResolvable)
//  .engine(java.lang.String)
//  .engine(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .instanceId(java.lang.String)
//  .instanceId(IResolvable)
//  .nodeId(java.lang.String)
//  .nodeId(IResolvable)
//  .orderType(java.lang.String)
//  .orderType(IResolvable)
//  .productType(java.lang.String)
//  .productType(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(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.
acceptLanguage	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property acceptLanguage: The language of the return values.
engine	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property engine: The engine type.
instanceChargeType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceChargeType: The billing method.
instanceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceId: The ID of the resource group.
nodeId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property nodeId: The ID of the data node for which you want to query available instance types.
orderType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property orderType: The order type.
productType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property productType: The edition or series of instances.
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.
resourceGroupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resourceGroupId: The ID of the instance.
zoneId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property zoneId: The ID of the zone where PolarDB resources that you want to query reside.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

acceptLanguage^Optional

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

Property acceptLanguage: The language of the return values.

Valid values: zh-CN: Chinese. This is the default value. en-US: English.

---

engine^Optional

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

Property engine: The engine type.

Valid values: Redis Memcache

---

instanceChargeType^Optional

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

Property instanceChargeType: The billing method.

Valid values: PrePaid: subscription PostPaid: pay-as-you-go Note Default value: PrePaid.

---

instanceId^Optional

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

Property instanceId: The ID of the resource group.

You can call the ListResourceGroups operation to query the IDs of resource groups. Note You can also query the IDs of resource groups in the Resource Management console. For more information, see View basic information about a resource group.

---

nodeId^Optional

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

Property nodeId: The ID of the data node for which you want to query available instance types.

You can call the DescribeLogicInstanceTopology operation to query the ID of the data node. Remove the number sign (#) and the content that follows the number sign. For example, retain only r-bp10noxlhcoim2****-db-0. Note Before you set this parameter, you must set the InstanceId parameter to the ID of an instance in the cluster or read/write splitting architecture.

---

orderType^Optional

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

Property orderType: The order type.

Valid values: BUY: the orders that are used to purchase instances. UPGRADE: the orders that are used to upgrade instances. DOWNGRADE: the orders that are used to downgrade instances.

---

productType^Optional

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

Property productType: The edition or series of instances.

Valid values: Local: ApsaraDB for Redis Community Edition instances or performance-enhanced instances of ApsaraDB for Redis Enhanced Edition (Tair) Tair_scm: persistent memory-optimized instances Tair_essd: storage-optimized instances

---

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.

---

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the instance.

Note This parameter is required only if the OrderType parameter is set to UPGRADE or RENEW.

---

zoneId^Optional

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

Property zoneId: The ID of the zone where PolarDB resources that you want to query reside.

Note You can call the DescribeRegions operation to query information about zones.

---

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.redis.datasource.InstanceClasses;
InstanceClasses.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.
attrInstanceClasses	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceClasses: The list of instance classes.
attrInstanceClassIds	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceClassIds: The list of db instance class ids.

---

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

---

attrInstanceClasses^Required

public IResolvable getAttrInstanceClasses();

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

Attribute InstanceClasses: The list of instance classes.

---

attrInstanceClassIds^Required

public IResolvable getAttrInstanceClassIds();

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

Attribute InstanceClassIds: The list of db instance class ids.

---