Skip to content

Instances

This class encapsulates and extends the ROS resource type DATASOURCE::REDIS::Instances, which is used to query the information about ApsaraDB for Redis instances.

Initializers 

from ros_cdk_redis import datasource
datasource.Instances(
  scope: Construct,
  id: str,
  architecture_type: typing.Union[str, IResolvable] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  edition_type: typing.Union[str, IResolvable] = None,
  engine_version: typing.Union[str, IResolvable] = None,
  expired: typing.Union[str, IResolvable] = None,
  global_instance: typing.Union[str, IResolvable] = None,
  instance_class: typing.Union[str, IResolvable] = None,
  instance_ids: typing.Union[str, IResolvable] = None,
  instance_status: typing.Union[str, IResolvable] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  network_type: typing.Union[str, IResolvable] = None,
  private_ip: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  search_key: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_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.
architecture_type typing.Union[str, ros_cdk_core.IResolvable] Property architectureType: The architecture of the instance.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The billing method of the instance.
edition_type typing.Union[str, ros_cdk_core.IResolvable] Property editionType: The edition of the instance.
engine_version typing.Union[str, ros_cdk_core.IResolvable] Property engineVersion: The database engine version of the instance.
expired typing.Union[str, ros_cdk_core.IResolvable] Property expired: Specifies whether the instance has expired.
global_instance typing.Union[str, ros_cdk_core.IResolvable] Property globalInstance: Specifies whether to return the child instances of distributed instances.
instance_class typing.Union[str, ros_cdk_core.IResolvable] Property instanceClass: The instance type.
instance_ids typing.Union[str, ros_cdk_core.IResolvable] Property instanceIds: The IDs of instances.
instance_status typing.Union[str, ros_cdk_core.IResolvable] Property instanceStatus: The state of the instance.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: The category of the instance.
network_type typing.Union[str, ros_cdk_core.IResolvable] Property networkType: The network type of the instance.
private_ip typing.Union[str, ros_cdk_core.IResolvable] Property privateIp: The private IP address of the instance.
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 resource group to which the instance belongs.
search_key typing.Union[str, ros_cdk_core.IResolvable] Property searchKey: The keyword used for fuzzy search.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the VSwitch.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone ID of the instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

architecture_typeOptional

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

Property architectureType: The architecture of the instance.

Valid values: cluster: The instance is a cluster instance. standard: The instance is a standard instance. rwsplit: The instance is a read/write splitting instance.

charge_typeOptional

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

Property chargeType: The billing method of the instance.

Valid values: PrePaid: subscription PostPaid: pay-as-you-go

edition_typeOptional

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

Property editionType: The edition of the instance.

Valid values: Community: Community Edition Enterprise: Enhance Edition (Tair)

engine_versionOptional

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

Property engineVersion: The database engine version of the instance.

Valid values: 2.8, 4.0, and 5.0.

expiredOptional

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

Property expired: Specifies whether the instance has expired.

Valid values: true: The instance has expired. false: The instance has not expired.

global_instanceOptional

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

Property globalInstance: Specifies whether to return the child instances of distributed instances.

Valid values: true: Only child instances are returned. false: Child instances are not returned.

instance_classOptional

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

Property instanceClass: The instance type.

instance_idsOptional

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

Property instanceIds: The IDs of instances.

If you specify multiple instance IDs, separate the instance IDs with commas (,).

instance_statusOptional

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

Property instanceStatus: The state of the instance.

Valid values: Normal: The instance is normal. Creating: The instance is being created. Changing: The configurations of the instance are being changed. Inactive: The instance is disabled. Flushing: The instance is being released. Released: The instance is released. Transforming: The instance is being transformed. Unavailable: The instance is suspended. Error: The instance cannot be created. Migrating: The instance is being migrated. BackupRecovering: The instance is being restored from a backup. MinorVersionUpgrading: The minor version of the instance is being updated. NetworkModifying: The network type of the instance is being changed. SSLModifying: The SSL certificate of the instance is being changed. MajorVersionUpgrading: The major version of the instance is being upgraded. The instance remains available during the upgrade.

instance_typeOptional

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

Property instanceType: The category of the instance.

Valid values: Tair Redis Memcache

network_typeOptional

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

Property networkType: The network type of the instance.

Valid values: CLASSIC: classic network VPC: Virtual Private Cloud (VPC)

private_ipOptional

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

Property privateIp: The private IP address of the instance.

refresh_optionsOptional

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

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

Property resourceGroupId: The ID of the resource group to which the instance belongs.

search_keyOptional

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

Property searchKey: The keyword used for fuzzy search.

The keyword can be based on an instance name or an instance ID.

vpc_idOptional

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

Property vpcId: The ID of the VPC.

v_switch_idOptional

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

Property vSwitchId: The ID of the VSwitch.

zone_idOptional

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

Property zoneId: The zone ID of the instance.

enable_resource_property_constraintOptional

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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • 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.Instances.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • 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_ids ros_cdk_core.IResolvable Attribute InstanceIds: The list of The Redis instance Ids.
attr_instances ros_cdk_core.IResolvable Attribute Instances: The list of The Redis instances.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_instance_idsRequired 

attr_instance_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceIds: The list of The Redis instance Ids.

attr_instancesRequired 

attr_instances: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Instances: The list of The Redis instances.