Skip to content

InstancesProps

Properties for defining a Instances.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-redis-instances

Initializer

from ros_cdk_redis import datasource
datasource.InstancesProps(
  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
)

Properties

Name Type 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.

architecture_typeOptional

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

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

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

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

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

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

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

Property instanceClass: The instance type.


instance_idsOptional

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

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

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

Property instanceType: The category of the instance.

Valid values: Tair Redis Memcache


network_typeOptional

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

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

Property privateIp: The private IP address of the instance.


refresh_optionsOptional

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

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

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


search_keyOptional

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

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

Property vpcId: The ID of the VPC.


v_switch_idOptional

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

Property vSwitchId: The ID of the VSwitch.


zone_idOptional

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

Property zoneId: The zone ID of the instance.