GetInstances

The alicloud.kvstore.getInstances data source provides a collection of kvstore instances available in Alicloud account. Filters support regular expression for the instance name, searches by tags, and other filters which are listed below.

Using GetInstances

function getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>

function  get_instances(ids=None, instance_class=None, instance_type=None, name_regex=None, output_file=None, status=None, tags=None, vpc_id=None, vswitch_id=None, opts=None)

func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)

public static class GetInstances {
    public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Ids List<string>: A list of RKV instance IDs.
InstanceClass string: Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
InstanceType string: Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.
NameRegex string: A regex string to apply to the instance name.
OutputFile string
Status string: Status of the instance.
Tags Dictionary<string, object>: Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
VpcId string: Used to retrieve instances belong to specified VPC.
VswitchId string: Used to retrieve instances belong to specified vswitch resources.

Ids []string: A list of RKV instance IDs.
InstanceClass string: Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
InstanceType string: Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.
NameRegex string: A regex string to apply to the instance name.
OutputFile string
Status string: Status of the instance.
Tags map[string]interface{}: Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
VpcId string: Used to retrieve instances belong to specified VPC.
VswitchId string: Used to retrieve instances belong to specified vswitch resources.

ids string[]: A list of RKV instance IDs.
instanceClass string: Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
instanceType string: Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.
nameRegex string: A regex string to apply to the instance name.
outputFile string
status string: Status of the instance.
tags {[key: string]: any}: Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
vpcId string: Used to retrieve instances belong to specified VPC.
vswitchId string: Used to retrieve instances belong to specified vswitch resources.

ids List[str]: A list of RKV instance IDs.
instance_class str: Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
instance_type str: Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.
name_regex str: A regex string to apply to the instance name.
output_file str
status str: Status of the instance.
tags Dict[str, Any]: Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
vpc_id str: Used to retrieve instances belong to specified VPC.
vswitch_id str: Used to retrieve instances belong to specified vswitch resources.

GetInstances Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: A list of RKV instance IDs.
Instances List<Pulumi.AliCloud.KVStore.Outputs.GetInstancesInstance>: A list of RKV instances. Its every element contains the following attributes:
Names List<string>
InstanceClass string
InstanceType string: (Optional) Database type. Options are Memcache, and Redis. If no value is specified, all types are returned. * instance_class- (Optional) Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
NameRegex string
OutputFile string
Status string: Status of the instance.
Tags Dictionary<string, object>
VpcId string: VPC ID the instance belongs to.
VswitchId string: VSwitch ID the instance belongs to.

Id string: The provider-assigned unique ID for this managed resource.
Ids []string: A list of RKV instance IDs.
Instances []GetInstancesInstance: A list of RKV instances. Its every element contains the following attributes:
Names []string
InstanceClass string
InstanceType string: (Optional) Database type. Options are Memcache, and Redis. If no value is specified, all types are returned. * instance_class- (Optional) Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
NameRegex string
OutputFile string
Status string: Status of the instance.
Tags map[string]interface{}
VpcId string: VPC ID the instance belongs to.
VswitchId string: VSwitch ID the instance belongs to.

id string: The provider-assigned unique ID for this managed resource.
ids string[]: A list of RKV instance IDs.
instances GetInstancesInstance[]: A list of RKV instances. Its every element contains the following attributes:
names string[]
instanceClass string
instanceType string: (Optional) Database type. Options are Memcache, and Redis. If no value is specified, all types are returned. * instance_class- (Optional) Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
nameRegex string
outputFile string
status string: Status of the instance.
tags {[key: string]: any}
vpcId string: VPC ID the instance belongs to.
vswitchId string: VSwitch ID the instance belongs to.

id str: The provider-assigned unique ID for this managed resource.
ids List[str]: A list of RKV instance IDs.
instances List[GetInstancesInstance]: A list of RKV instances. Its every element contains the following attributes:
names List[str]
instance_class str
instance_type str: (Optional) Database type. Options are Memcache, and Redis. If no value is specified, all types are returned. * instance_class- (Optional) Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
name_regex str
output_file str
status str: Status of the instance.
tags Dict[str, Any]
vpc_id str: VPC ID the instance belongs to.
vswitch_id str: VSwitch ID the instance belongs to.

Supporting Types

GetInstancesInstance

See the output API doc for this type.

AvailabilityZone string: Availability zone.
Bandwidth int: Instance bandwidth limit. Unit: Mbit/s.
Capacity int: Capacity of the applied ApsaraDB for Redis instance. Unit: MB.
ChargeType string: Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.
ConnectionDomain string
Connections int: Instance connection quantity limit. Unit: count.
CreateTime string: Creation time of the instance.
ExpireTime string: Expiration time. Pay-As-You-Go instances are never expire.
Id string: The ID of the RKV instance.
InstanceClass string: Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
InstanceType string: Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.
Name string: The name of the RKV instance.
Port int: Connection port of the instance.
PrivateIp string: Private IP address of the instance.
RegionId string: Region ID the instance belongs to.
Status string: Status of the instance.
UserName string
VpcId string: Used to retrieve instances belong to specified VPC.
VswitchId string: Used to retrieve instances belong to specified vswitch resources.

AvailabilityZone string: Availability zone.
Bandwidth int: Instance bandwidth limit. Unit: Mbit/s.
Capacity int: Capacity of the applied ApsaraDB for Redis instance. Unit: MB.
ChargeType string: Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.
ConnectionDomain string
Connections int: Instance connection quantity limit. Unit: count.
CreateTime string: Creation time of the instance.
ExpireTime string: Expiration time. Pay-As-You-Go instances are never expire.
Id string: The ID of the RKV instance.
InstanceClass string: Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
InstanceType string: Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.
Name string: The name of the RKV instance.
Port int: Connection port of the instance.
PrivateIp string: Private IP address of the instance.
RegionId string: Region ID the instance belongs to.
Status string: Status of the instance.
UserName string
VpcId string: Used to retrieve instances belong to specified VPC.
VswitchId string: Used to retrieve instances belong to specified vswitch resources.

availabilityZone string: Availability zone.
bandwidth number: Instance bandwidth limit. Unit: Mbit/s.
capacity number: Capacity of the applied ApsaraDB for Redis instance. Unit: MB.
chargeType string: Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.
connectionDomain string
connections number: Instance connection quantity limit. Unit: count.
createTime string: Creation time of the instance.
expireTime string: Expiration time. Pay-As-You-Go instances are never expire.
id string: The ID of the RKV instance.
instanceClass string: Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
instanceType string: Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.
name string: The name of the RKV instance.
port number: Connection port of the instance.
privateIp string: Private IP address of the instance.
regionId string: Region ID the instance belongs to.
status string: Status of the instance.
userName string
vpcId string: Used to retrieve instances belong to specified VPC.
vswitchId string: Used to retrieve instances belong to specified vswitch resources.

availability_zone str: Availability zone.
bandwidth float: Instance bandwidth limit. Unit: Mbit/s.
capacity float: Capacity of the applied ApsaraDB for Redis instance. Unit: MB.
charge_type str: Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.
connection_domain str
connections float: Instance connection quantity limit. Unit: count.
create_time str: Creation time of the instance.
expire_time str: Expiration time. Pay-As-You-Go instances are never expire.
id str: The ID of the RKV instance.
instance_class str: Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
instance_type str: Database type. Options are Memcache, and Redis. If no value is specified, all types are returned.
name str: The name of the RKV instance.
port float: Connection port of the instance.
private_ip str: Private IP address of the instance.
regionId str: Region ID the instance belongs to.
status str: Status of the instance.
user_name str
vpc_id str: Used to retrieve instances belong to specified VPC.
vswitch_id str: Used to retrieve instances belong to specified vswitch resources.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud