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

from ros_cdk_redis import datasource
datasource.InstanceClasses(
  scope: Construct,
  id: str,
  accept_language: typing.Union[str, IResolvable] = None,
  engine: typing.Union[str, IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  node_id: typing.Union[str, IResolvable] = None,
  order_type: typing.Union[str, IResolvable] = None,
  product_type: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
accept_language	typing.Union[str, ros_cdk_core.IResolvable]	Property acceptLanguage: The language of the return values.
engine	typing.Union[str, ros_cdk_core.IResolvable]	Property engine: The engine type.
instance_charge_type	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceChargeType: The billing method.
instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceId: The ID of the resource group.
node_id	typing.Union[str, ros_cdk_core.IResolvable]	Property nodeId: The ID of the data node for which you want to query available instance types.
order_type	typing.Union[str, ros_cdk_core.IResolvable]	Property orderType: The order type.
product_type	typing.Union[str, ros_cdk_core.IResolvable]	Property productType: The edition or series of instances.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: The ID of the instance.
zone_id	typing.Union[str, ros_cdk_core.IResolvable]	Property zoneId: The ID of the zone where PolarDB resources that you want to query reside.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

accept_language^Optional

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

Property engine: The engine type.

Valid values: Redis Memcache

---

instance_charge_type^Optional

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

Property instanceChargeType: The billing method.

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

---

instance_id^Optional

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

---

node_id^Optional

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

---

order_type^Optional

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

---

product_type^Optional

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

---

refresh_options^Optional

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

---

resource_group_id^Optional

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

---

zone_id^Optional

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

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

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

---

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

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

---

is_construct

from ros_cdk_redis import datasource
datasource.InstanceClasses.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_instance_classes	ros_cdk_core.IResolvable	Attribute InstanceClasses: The list of instance classes.
attr_instance_class_ids	ros_cdk_core.IResolvable	Attribute InstanceClassIds: The list of db instance class ids.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_instance_classes^Required

attr_instance_classes: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceClasses: The list of instance classes.

---

attr_instance_class_ids^Required

attr_instance_class_ids: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceClassIds: The list of db instance class ids.

---