Skip to content

InstancesProps

Properties for defining a Instances.

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

Initializer

import { datasource } from '@alicloud/ros-cdk-redis'
const instancesProps: datasource.InstancesProps = { ... }

Properties

Name Type Description
architectureType string | @alicloud/ros-cdk-core.IResolvable Property architectureType: The architecture of the instance.
chargeType string | @alicloud/ros-cdk-core.IResolvable Property chargeType: The billing method of the instance.
editionType string | @alicloud/ros-cdk-core.IResolvable Property editionType: The edition of the instance.
engineVersion string | @alicloud/ros-cdk-core.IResolvable Property engineVersion: The database engine version of the instance.
expired string | @alicloud/ros-cdk-core.IResolvable Property expired: Specifies whether the instance has expired.
globalInstance string | @alicloud/ros-cdk-core.IResolvable Property globalInstance: Specifies whether to return the child instances of distributed instances.
instanceClass string | @alicloud/ros-cdk-core.IResolvable Property instanceClass: The instance type.
instanceIds string | @alicloud/ros-cdk-core.IResolvable Property instanceIds: The IDs of instances.
instanceStatus string | @alicloud/ros-cdk-core.IResolvable Property instanceStatus: The state of the instance.
instanceType string | @alicloud/ros-cdk-core.IResolvable Property instanceType: The category of the instance.
networkType string | @alicloud/ros-cdk-core.IResolvable Property networkType: The network type of the instance.
privateIp string | @alicloud/ros-cdk-core.IResolvable Property privateIp: The private IP address of the instance.
refreshOptions string | @alicloud/ros-cdk-core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group to which the instance belongs.
searchKey string | @alicloud/ros-cdk-core.IResolvable Property searchKey: The keyword used for fuzzy search.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the VPC.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the VSwitch.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone ID of the instance.

architectureTypeOptional

public readonly architectureType: string | IResolvable;
  • Type: string | @alicloud/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.


chargeTypeOptional

public readonly chargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property chargeType: The billing method of the instance.

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


editionTypeOptional

public readonly editionType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property editionType: The edition of the instance.

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


engineVersionOptional

public readonly engineVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property engineVersion: The database engine version of the instance.

Valid values: 2.8, 4.0, and 5.0.


expiredOptional

public readonly expired: string | IResolvable;
  • Type: string | @alicloud/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.


globalInstanceOptional

public readonly globalInstance: string | IResolvable;
  • Type: string | @alicloud/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.


instanceClassOptional

public readonly instanceClass: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceClass: The instance type.


instanceIdsOptional

public readonly instanceIds: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceIds: The IDs of instances.

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


instanceStatusOptional

public readonly instanceStatus: string | IResolvable;
  • Type: string | @alicloud/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.


instanceTypeOptional

public readonly instanceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceType: The category of the instance.

Valid values: Tair Redis Memcache


networkTypeOptional

public readonly networkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property networkType: The network type of the instance.

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


privateIpOptional

public readonly privateIp: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property privateIp: The private IP address of the instance.


refreshOptionsOptional

public readonly refreshOptions: string | IResolvable;
  • Type: string | @alicloud/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.


resourceGroupIdOptional

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


searchKeyOptional

public readonly searchKey: string | IResolvable;
  • Type: string | @alicloud/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.


vpcIdOptional

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The ID of the VPC.


vSwitchIdOptional

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of the VSwitch.


zoneIdOptional

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The zone ID of the instance.