Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. kvstore
  5. getInstances
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.kvstore.getInstances

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-alicloud

    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.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const default = alicloud.kvstore.getInstances({
    nameRegex: "testname",
});
export const firstInstanceName = _default.then(_default => _default.instances?.[0]?.name);

    import pulumi
import pulumi_alicloud as alicloud

default = alicloud.kvstore.get_instances(name_regex="testname")
pulumi.export("firstInstanceName", default.instances[0].name)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/kvstore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := kvstore.GetInstances(ctx, &kvstore.GetInstancesArgs{
			NameRegex: pulumi.StringRef("testname"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstInstanceName", _default.Instances[0].Name)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var @default = AliCloud.KVStore.GetInstances.Invoke(new()
    {
        NameRegex = "testname",
    });

    return new Dictionary<string, object?>
    {
        ["firstInstanceName"] = @default.Apply(@default => @default.Apply(getInstancesResult => getInstancesResult.Instances[0]?.Name)),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.kvstore.KvstoreFunctions;
import com.pulumi.alicloud.kvstore.inputs.GetInstancesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = KvstoreFunctions.getInstances(GetInstancesArgs.builder()
            .nameRegex("testname")
            .build());

        ctx.export("firstInstanceName", default_.instances()[0].name());
    }
}

    variables:
  default:
    fn::invoke:
      Function: alicloud:kvstore:getInstances
      Arguments:
        nameRegex: testname
outputs:
  firstInstanceName: ${default.instances[0].name}

    Using getInstances

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>
    def get_instances(architecture_type: Optional[str] = None,
                  edition_type: Optional[str] = None,
                  enable_details: Optional[bool] = None,
                  engine_version: Optional[str] = None,
                  expired: Optional[str] = None,
                  global_instance: Optional[bool] = None,
                  ids: Optional[Sequence[str]] = None,
                  instance_class: Optional[str] = None,
                  instance_type: Optional[str] = None,
                  name_regex: Optional[str] = None,
                  network_type: Optional[str] = None,
                  output_file: Optional[str] = None,
                  payment_type: Optional[str] = None,
                  resource_group_id: Optional[str] = None,
                  search_key: Optional[str] = None,
                  status: Optional[str] = None,
                  tags: Optional[Mapping[str, Any]] = None,
                  vpc_id: Optional[str] = None,
                  vswitch_id: Optional[str] = None,
                  zone_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(architecture_type: Optional[pulumi.Input[str]] = None,
                  edition_type: Optional[pulumi.Input[str]] = None,
                  enable_details: Optional[pulumi.Input[bool]] = None,
                  engine_version: Optional[pulumi.Input[str]] = None,
                  expired: Optional[pulumi.Input[str]] = None,
                  global_instance: Optional[pulumi.Input[bool]] = None,
                  ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  instance_class: Optional[pulumi.Input[str]] = None,
                  instance_type: Optional[pulumi.Input[str]] = None,
                  name_regex: Optional[pulumi.Input[str]] = None,
                  network_type: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  payment_type: Optional[pulumi.Input[str]] = None,
                  resource_group_id: Optional[pulumi.Input[str]] = None,
                  search_key: Optional[pulumi.Input[str]] = None,
                  status: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
                  vpc_id: Optional[pulumi.Input[str]] = None,
                  vswitch_id: Optional[pulumi.Input[str]] = None,
                  zone_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]
    func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput

    > Note: This function is named GetInstances in the Go SDK.

    public static class GetInstances 
{
    public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: alicloud:kvstore/getInstances:getInstances
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ArchitectureType string
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    EditionType string
    Used to retrieve instances belong to specified vswitch resources. Valid values: Enterprise, Community.
    EnableDetails bool
    Default to false. Set it to true can output more details.
    EngineVersion string
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    Expired string
    The expiration status of the instance.
    GlobalInstance bool
    Whether to create a distributed cache.
    Ids List<string>
    A list of KVStore DBInstance IDs.
    InstanceClass string
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    InstanceType string
    The engine type of the KVStore DBInstance. 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.
    NetworkType string
    The type of the network. Valid values: CLASSIC, VPC.
    OutputFile string
    The name of file that can save the collection of instances after running pulumi preview.
    PaymentType string
    The payment type. Valid values: PostPaid, PrePaid.
    ResourceGroupId string
    The ID of the resource group.
    SearchKey string
    The name of the instance.
    Status string
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    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.
    ZoneId string
    The ID of the zone.
    ArchitectureType string
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    EditionType string
    Used to retrieve instances belong to specified vswitch resources. Valid values: Enterprise, Community.
    EnableDetails bool
    Default to false. Set it to true can output more details.
    EngineVersion string
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    Expired string
    The expiration status of the instance.
    GlobalInstance bool
    Whether to create a distributed cache.
    Ids []string
    A list of KVStore DBInstance IDs.
    InstanceClass string
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    InstanceType string
    The engine type of the KVStore DBInstance. 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.
    NetworkType string
    The type of the network. Valid values: CLASSIC, VPC.
    OutputFile string
    The name of file that can save the collection of instances after running pulumi preview.
    PaymentType string
    The payment type. Valid values: PostPaid, PrePaid.
    ResourceGroupId string
    The ID of the resource group.
    SearchKey string
    The name of the instance.
    Status string
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    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.
    ZoneId string
    The ID of the zone.
    architectureType String
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    editionType String
    Used to retrieve instances belong to specified vswitch resources. Valid values: Enterprise, Community.
    enableDetails Boolean
    Default to false. Set it to true can output more details.
    engineVersion String
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    expired String
    The expiration status of the instance.
    globalInstance Boolean
    Whether to create a distributed cache.
    ids List<String>
    A list of KVStore DBInstance IDs.
    instanceClass String
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    instanceType String
    The engine type of the KVStore DBInstance. 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.
    networkType String
    The type of the network. Valid values: CLASSIC, VPC.
    outputFile String
    The name of file that can save the collection of instances after running pulumi preview.
    paymentType String
    The payment type. Valid values: PostPaid, PrePaid.
    resourceGroupId String
    The ID of the resource group.
    searchKey String
    The name of the instance.
    status String
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    tags Map<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.
    zoneId String
    The ID of the zone.
    architectureType string
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    editionType string
    Used to retrieve instances belong to specified vswitch resources. Valid values: Enterprise, Community.
    enableDetails boolean
    Default to false. Set it to true can output more details.
    engineVersion string
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    expired string
    The expiration status of the instance.
    globalInstance boolean
    Whether to create a distributed cache.
    ids string[]
    A list of KVStore DBInstance IDs.
    instanceClass string
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    instanceType string
    The engine type of the KVStore DBInstance. 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.
    networkType string
    The type of the network. Valid values: CLASSIC, VPC.
    outputFile string
    The name of file that can save the collection of instances after running pulumi preview.
    paymentType string
    The payment type. Valid values: PostPaid, PrePaid.
    resourceGroupId string
    The ID of the resource group.
    searchKey string
    The name of the instance.
    status string
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    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.
    zoneId string
    The ID of the zone.
    architecture_type str
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    edition_type str
    Used to retrieve instances belong to specified vswitch resources. Valid values: Enterprise, Community.
    enable_details bool
    Default to false. Set it to true can output more details.
    engine_version str
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    expired str
    The expiration status of the instance.
    global_instance bool
    Whether to create a distributed cache.
    ids Sequence[str]
    A list of KVStore DBInstance IDs.
    instance_class str
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    instance_type str
    The engine type of the KVStore DBInstance. 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.
    network_type str
    The type of the network. Valid values: CLASSIC, VPC.
    output_file str
    The name of file that can save the collection of instances after running pulumi preview.
    payment_type str
    The payment type. Valid values: PostPaid, PrePaid.
    resource_group_id str
    The ID of the resource group.
    search_key str
    The name of the instance.
    status str
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    tags Mapping[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.
    zone_id str
    The ID of the zone.
    architectureType String
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    editionType String
    Used to retrieve instances belong to specified vswitch resources. Valid values: Enterprise, Community.
    enableDetails Boolean
    Default to false. Set it to true can output more details.
    engineVersion String
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    expired String
    The expiration status of the instance.
    globalInstance Boolean
    Whether to create a distributed cache.
    ids List<String>
    A list of KVStore DBInstance IDs.
    instanceClass String
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    instanceType String
    The engine type of the KVStore DBInstance. 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.
    networkType String
    The type of the network. Valid values: CLASSIC, VPC.
    outputFile String
    The name of file that can save the collection of instances after running pulumi preview.
    paymentType String
    The payment type. Valid values: PostPaid, PrePaid.
    resourceGroupId String
    The ID of the resource group.
    searchKey String
    The name of the instance.
    status String
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    tags Map<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.
    zoneId String
    The ID of the zone.

    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 KVStore Instance IDs.
    Instances List<Pulumi.AliCloud.KVStore.Outputs.GetInstancesInstance>
    A list of KVStore Instances. Its every element contains the following attributes:
    Names List<string>
    A list of KVStore Instance names.
    ArchitectureType string
    EditionType string
    EnableDetails bool
    EngineVersion string
    The engine version of the instance.
    Expired string
    GlobalInstance bool
    InstanceClass string
    (Optional) Type of the applied ApsaraDB for instance. For more information, see Instance type table.
    InstanceType string
    (Optional) Database type. Valid Values: Memcache, Redis. If no value is specified, all types are returned.
    NameRegex string
    NetworkType string
    The network type of the instance.
    OutputFile string
    PaymentType string
    Billing method. Valid Values: PostPaid for Pay-As-You-Go and PrePaid for subscription.
    ResourceGroupId string
    SearchKey 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.
    ZoneId string
    The ID of zone.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    A list of KVStore Instance IDs.
    Instances []GetInstancesInstance
    A list of KVStore Instances. Its every element contains the following attributes:
    Names []string
    A list of KVStore Instance names.
    ArchitectureType string
    EditionType string
    EnableDetails bool
    EngineVersion string
    The engine version of the instance.
    Expired string
    GlobalInstance bool
    InstanceClass string
    (Optional) Type of the applied ApsaraDB for instance. For more information, see Instance type table.
    InstanceType string
    (Optional) Database type. Valid Values: Memcache, Redis. If no value is specified, all types are returned.
    NameRegex string
    NetworkType string
    The network type of the instance.
    OutputFile string
    PaymentType string
    Billing method. Valid Values: PostPaid for Pay-As-You-Go and PrePaid for subscription.
    ResourceGroupId string
    SearchKey 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.
    ZoneId string
    The ID of zone.
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of KVStore Instance IDs.
    instances List<GetInstancesInstance>
    A list of KVStore Instances. Its every element contains the following attributes:
    names List<String>
    A list of KVStore Instance names.
    architectureType String
    editionType String
    enableDetails Boolean
    engineVersion String
    The engine version of the instance.
    expired String
    globalInstance Boolean
    instanceClass String
    (Optional) Type of the applied ApsaraDB for instance. For more information, see Instance type table.
    instanceType String
    (Optional) Database type. Valid Values: Memcache, Redis. If no value is specified, all types are returned.
    nameRegex String
    networkType String
    The network type of the instance.
    outputFile String
    paymentType String
    Billing method. Valid Values: PostPaid for Pay-As-You-Go and PrePaid for subscription.
    resourceGroupId String
    searchKey String
    status String
    Status of the instance.
    tags Map<String,Object>
    vpcId String
    VPC ID the instance belongs to.
    vswitchId String
    VSwitch ID the instance belongs to.
    zoneId String
    The ID of zone.
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    A list of KVStore Instance IDs.
    instances GetInstancesInstance[]
    A list of KVStore Instances. Its every element contains the following attributes:
    names string[]
    A list of KVStore Instance names.
    architectureType string
    editionType string
    enableDetails boolean
    engineVersion string
    The engine version of the instance.
    expired string
    globalInstance boolean
    instanceClass string
    (Optional) Type of the applied ApsaraDB for instance. For more information, see Instance type table.
    instanceType string
    (Optional) Database type. Valid Values: Memcache, Redis. If no value is specified, all types are returned.
    nameRegex string
    networkType string
    The network type of the instance.
    outputFile string
    paymentType string
    Billing method. Valid Values: PostPaid for Pay-As-You-Go and PrePaid for subscription.
    resourceGroupId string
    searchKey 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.
    zoneId string
    The ID of zone.
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    A list of KVStore Instance IDs.
    instances Sequence[GetInstancesInstance]
    A list of KVStore Instances. Its every element contains the following attributes:
    names Sequence[str]
    A list of KVStore Instance names.
    architecture_type str
    edition_type str
    enable_details bool
    engine_version str
    The engine version of the instance.
    expired str
    global_instance bool
    instance_class str
    (Optional) Type of the applied ApsaraDB for instance. For more information, see Instance type table.
    instance_type str
    (Optional) Database type. Valid Values: Memcache, Redis. If no value is specified, all types are returned.
    name_regex str
    network_type str
    The network type of the instance.
    output_file str
    payment_type str
    Billing method. Valid Values: PostPaid for Pay-As-You-Go and PrePaid for subscription.
    resource_group_id str
    search_key str
    status str
    Status of the instance.
    tags Mapping[str, Any]
    vpc_id str
    VPC ID the instance belongs to.
    vswitch_id str
    VSwitch ID the instance belongs to.
    zone_id str
    The ID of zone.
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of KVStore Instance IDs.
    instances List<Property Map>
    A list of KVStore Instances. Its every element contains the following attributes:
    names List<String>
    A list of KVStore Instance names.
    architectureType String
    editionType String
    enableDetails Boolean
    engineVersion String
    The engine version of the instance.
    expired String
    globalInstance Boolean
    instanceClass String
    (Optional) Type of the applied ApsaraDB for instance. For more information, see Instance type table.
    instanceType String
    (Optional) Database type. Valid Values: Memcache, Redis. If no value is specified, all types are returned.
    nameRegex String
    networkType String
    The network type of the instance.
    outputFile String
    paymentType String
    Billing method. Valid Values: PostPaid for Pay-As-You-Go and PrePaid for subscription.
    resourceGroupId String
    searchKey String
    status String
    Status of the instance.
    tags Map<Any>
    vpcId String
    VPC ID the instance belongs to.
    vswitchId String
    VSwitch ID the instance belongs to.
    zoneId String
    The ID of zone.

    Supporting Types

    GetInstancesInstance

    ArchitectureType string
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    AutoRenew bool
    AutoRenewPeriod int
    AvailabilityZone string
    It has been deprecated from provider version 1.101.0 and zone_id instead.
    Bandwidth int
    Instance bandwidth limit. Unit: Mbit/s.
    Capacity int
    Capacity of the applied ApsaraDB for the instance. Unit: MB.
    ChargeType string
    It has been deprecated from provider version 1.101.0 and payment_type instead.
    Config Dictionary<string, object>
    The parameter configuration of the instance.
    ConnectionDomain string
    Instance connection domain (only Intranet access supported).
    ConnectionMode string
    The connection mode of the instance.
    Connections int
    IIt has been deprecated from provider version 1.101.0 and max_connections instead.
    CreateTime string
    Creation time of the instance.
    DbInstanceId string
    The ID of the instance.
    DbInstanceName string
    The name of the instance.
    DestroyTime string
    The time when the instance was destroyed.
    EndTime string
    Expiration time. Pay-As-You-Go instances are never expire.
    EngineVersion string
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    ExpireTime string
    It has been deprecated from provider version 1.101.0 and end_time instead.
    HasRenewChangeOrder bool
    Indicates whether there was an order of renewal with configuration change that had not taken effect.
    Id string
    The ID of the instance.
    InstanceClass string
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    InstanceReleaseProtection bool
    InstanceType string
    The engine type of the KVStore DBInstance. Options are Memcache, and Redis. If no value is specified, all types are returned.
    IsRds bool
    Indicates whether the instance is managed by Relational Database Service (RDS).
    MaintainEndTime string
    MaintainStartTime string
    MaxConnections int
    Instance connection quantity limit. Unit: count.
    Name string
    It has been deprecated from provider version 1.101.0 and db_instance_name instead.
    NetworkType string
    The type of the network. Valid values: CLASSIC, VPC.
    NodeType string
    The node type of the instance.
    PackageType string
    The type of the package.
    PaymentType string
    The payment type. Valid values: PostPaid, PrePaid.
    Port int
    The service port of the instance.
    PrivateIp string
    Private IP address of the instance.
    Qps int
    The queries per second (QPS) supported by the instance.
    RegionId string
    Region ID the instance belongs to.
    ReplacateId string
    The logical ID of the replica instance.
    ResourceGroupId string
    The ID of the resource group.
    SearchKey string
    The name of the instance.
    SecondaryZoneId string
    (Optional, Available in 1.128.0+) The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.
    SecurityGroupId string
    SecurityIpGroupAttribute string
    SecurityIpGroupName string
    SecurityIps List<string>
    SslEnable string
    Status string
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    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"}.
    UserName string
    The username of the instance.
    VpcAuthMode string
    VpcCloudInstanceId string
    Connection port of the instance.
    VpcId string
    Used to retrieve instances belong to specified VPC.
    VswitchId string
    Used to retrieve instances belong to specified vswitch resources.
    ZoneId string
    The ID of the zone.
    ArchitectureType string
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    AutoRenew bool
    AutoRenewPeriod int
    AvailabilityZone string
    It has been deprecated from provider version 1.101.0 and zone_id instead.
    Bandwidth int
    Instance bandwidth limit. Unit: Mbit/s.
    Capacity int
    Capacity of the applied ApsaraDB for the instance. Unit: MB.
    ChargeType string
    It has been deprecated from provider version 1.101.0 and payment_type instead.
    Config map[string]interface{}
    The parameter configuration of the instance.
    ConnectionDomain string
    Instance connection domain (only Intranet access supported).
    ConnectionMode string
    The connection mode of the instance.
    Connections int
    IIt has been deprecated from provider version 1.101.0 and max_connections instead.
    CreateTime string
    Creation time of the instance.
    DbInstanceId string
    The ID of the instance.
    DbInstanceName string
    The name of the instance.
    DestroyTime string
    The time when the instance was destroyed.
    EndTime string
    Expiration time. Pay-As-You-Go instances are never expire.
    EngineVersion string
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    ExpireTime string
    It has been deprecated from provider version 1.101.0 and end_time instead.
    HasRenewChangeOrder bool
    Indicates whether there was an order of renewal with configuration change that had not taken effect.
    Id string
    The ID of the instance.
    InstanceClass string
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    InstanceReleaseProtection bool
    InstanceType string
    The engine type of the KVStore DBInstance. Options are Memcache, and Redis. If no value is specified, all types are returned.
    IsRds bool
    Indicates whether the instance is managed by Relational Database Service (RDS).
    MaintainEndTime string
    MaintainStartTime string
    MaxConnections int
    Instance connection quantity limit. Unit: count.
    Name string
    It has been deprecated from provider version 1.101.0 and db_instance_name instead.
    NetworkType string
    The type of the network. Valid values: CLASSIC, VPC.
    NodeType string
    The node type of the instance.
    PackageType string
    The type of the package.
    PaymentType string
    The payment type. Valid values: PostPaid, PrePaid.
    Port int
    The service port of the instance.
    PrivateIp string
    Private IP address of the instance.
    Qps int
    The queries per second (QPS) supported by the instance.
    RegionId string
    Region ID the instance belongs to.
    ReplacateId string
    The logical ID of the replica instance.
    ResourceGroupId string
    The ID of the resource group.
    SearchKey string
    The name of the instance.
    SecondaryZoneId string
    (Optional, Available in 1.128.0+) The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.
    SecurityGroupId string
    SecurityIpGroupAttribute string
    SecurityIpGroupName string
    SecurityIps []string
    SslEnable string
    Status string
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    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"}.
    UserName string
    The username of the instance.
    VpcAuthMode string
    VpcCloudInstanceId string
    Connection port of the instance.
    VpcId string
    Used to retrieve instances belong to specified VPC.
    VswitchId string
    Used to retrieve instances belong to specified vswitch resources.
    ZoneId string
    The ID of the zone.
    architectureType String
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    autoRenew Boolean
    autoRenewPeriod Integer
    availabilityZone String
    It has been deprecated from provider version 1.101.0 and zone_id instead.
    bandwidth Integer
    Instance bandwidth limit. Unit: Mbit/s.
    capacity Integer
    Capacity of the applied ApsaraDB for the instance. Unit: MB.
    chargeType String
    It has been deprecated from provider version 1.101.0 and payment_type instead.
    config Map<String,Object>
    The parameter configuration of the instance.
    connectionDomain String
    Instance connection domain (only Intranet access supported).
    connectionMode String
    The connection mode of the instance.
    connections Integer
    IIt has been deprecated from provider version 1.101.0 and max_connections instead.
    createTime String
    Creation time of the instance.
    dbInstanceId String
    The ID of the instance.
    dbInstanceName String
    The name of the instance.
    destroyTime String
    The time when the instance was destroyed.
    endTime String
    Expiration time. Pay-As-You-Go instances are never expire.
    engineVersion String
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    expireTime String
    It has been deprecated from provider version 1.101.0 and end_time instead.
    hasRenewChangeOrder Boolean
    Indicates whether there was an order of renewal with configuration change that had not taken effect.
    id String
    The ID of the instance.
    instanceClass String
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    instanceReleaseProtection Boolean
    instanceType String
    The engine type of the KVStore DBInstance. Options are Memcache, and Redis. If no value is specified, all types are returned.
    isRds Boolean
    Indicates whether the instance is managed by Relational Database Service (RDS).
    maintainEndTime String
    maintainStartTime String
    maxConnections Integer
    Instance connection quantity limit. Unit: count.
    name String
    It has been deprecated from provider version 1.101.0 and db_instance_name instead.
    networkType String
    The type of the network. Valid values: CLASSIC, VPC.
    nodeType String
    The node type of the instance.
    packageType String
    The type of the package.
    paymentType String
    The payment type. Valid values: PostPaid, PrePaid.
    port Integer
    The service port of the instance.
    privateIp String
    Private IP address of the instance.
    qps Integer
    The queries per second (QPS) supported by the instance.
    regionId String
    Region ID the instance belongs to.
    replacateId String
    The logical ID of the replica instance.
    resourceGroupId String
    The ID of the resource group.
    searchKey String
    The name of the instance.
    secondaryZoneId String
    (Optional, Available in 1.128.0+) The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.
    securityGroupId String
    securityIpGroupAttribute String
    securityIpGroupName String
    securityIps List<String>
    sslEnable String
    status String
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    tags Map<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"}.
    userName String
    The username of the instance.
    vpcAuthMode String
    vpcCloudInstanceId String
    Connection port of the instance.
    vpcId String
    Used to retrieve instances belong to specified VPC.
    vswitchId String
    Used to retrieve instances belong to specified vswitch resources.
    zoneId String
    The ID of the zone.
    architectureType string
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    autoRenew boolean
    autoRenewPeriod number
    availabilityZone string
    It has been deprecated from provider version 1.101.0 and zone_id instead.
    bandwidth number
    Instance bandwidth limit. Unit: Mbit/s.
    capacity number
    Capacity of the applied ApsaraDB for the instance. Unit: MB.
    chargeType string
    It has been deprecated from provider version 1.101.0 and payment_type instead.
    config {[key: string]: any}
    The parameter configuration of the instance.
    connectionDomain string
    Instance connection domain (only Intranet access supported).
    connectionMode string
    The connection mode of the instance.
    connections number
    IIt has been deprecated from provider version 1.101.0 and max_connections instead.
    createTime string
    Creation time of the instance.
    dbInstanceId string
    The ID of the instance.
    dbInstanceName string
    The name of the instance.
    destroyTime string
    The time when the instance was destroyed.
    endTime string
    Expiration time. Pay-As-You-Go instances are never expire.
    engineVersion string
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    expireTime string
    It has been deprecated from provider version 1.101.0 and end_time instead.
    hasRenewChangeOrder boolean
    Indicates whether there was an order of renewal with configuration change that had not taken effect.
    id string
    The ID of the instance.
    instanceClass string
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    instanceReleaseProtection boolean
    instanceType string
    The engine type of the KVStore DBInstance. Options are Memcache, and Redis. If no value is specified, all types are returned.
    isRds boolean
    Indicates whether the instance is managed by Relational Database Service (RDS).
    maintainEndTime string
    maintainStartTime string
    maxConnections number
    Instance connection quantity limit. Unit: count.
    name string
    It has been deprecated from provider version 1.101.0 and db_instance_name instead.
    networkType string
    The type of the network. Valid values: CLASSIC, VPC.
    nodeType string
    The node type of the instance.
    packageType string
    The type of the package.
    paymentType string
    The payment type. Valid values: PostPaid, PrePaid.
    port number
    The service port of the instance.
    privateIp string
    Private IP address of the instance.
    qps number
    The queries per second (QPS) supported by the instance.
    regionId string
    Region ID the instance belongs to.
    replacateId string
    The logical ID of the replica instance.
    resourceGroupId string
    The ID of the resource group.
    searchKey string
    The name of the instance.
    secondaryZoneId string
    (Optional, Available in 1.128.0+) The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.
    securityGroupId string
    securityIpGroupAttribute string
    securityIpGroupName string
    securityIps string[]
    sslEnable string
    status string
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    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"}.
    userName string
    The username of the instance.
    vpcAuthMode string
    vpcCloudInstanceId string
    Connection port of the instance.
    vpcId string
    Used to retrieve instances belong to specified VPC.
    vswitchId string
    Used to retrieve instances belong to specified vswitch resources.
    zoneId string
    The ID of the zone.
    architecture_type str
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    auto_renew bool
    auto_renew_period int
    availability_zone str
    It has been deprecated from provider version 1.101.0 and zone_id instead.
    bandwidth int
    Instance bandwidth limit. Unit: Mbit/s.
    capacity int
    Capacity of the applied ApsaraDB for the instance. Unit: MB.
    charge_type str
    It has been deprecated from provider version 1.101.0 and payment_type instead.
    config Mapping[str, Any]
    The parameter configuration of the instance.
    connection_domain str
    Instance connection domain (only Intranet access supported).
    connection_mode str
    The connection mode of the instance.
    connections int
    IIt has been deprecated from provider version 1.101.0 and max_connections instead.
    create_time str
    Creation time of the instance.
    db_instance_id str
    The ID of the instance.
    db_instance_name str
    The name of the instance.
    destroy_time str
    The time when the instance was destroyed.
    end_time str
    Expiration time. Pay-As-You-Go instances are never expire.
    engine_version str
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    expire_time str
    It has been deprecated from provider version 1.101.0 and end_time instead.
    has_renew_change_order bool
    Indicates whether there was an order of renewal with configuration change that had not taken effect.
    id str
    The ID of the instance.
    instance_class str
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    instance_release_protection bool
    instance_type str
    The engine type of the KVStore DBInstance. Options are Memcache, and Redis. If no value is specified, all types are returned.
    is_rds bool
    Indicates whether the instance is managed by Relational Database Service (RDS).
    maintain_end_time str
    maintain_start_time str
    max_connections int
    Instance connection quantity limit. Unit: count.
    name str
    It has been deprecated from provider version 1.101.0 and db_instance_name instead.
    network_type str
    The type of the network. Valid values: CLASSIC, VPC.
    node_type str
    The node type of the instance.
    package_type str
    The type of the package.
    payment_type str
    The payment type. Valid values: PostPaid, PrePaid.
    port int
    The service port of the instance.
    private_ip str
    Private IP address of the instance.
    qps int
    The queries per second (QPS) supported by the instance.
    region_id str
    Region ID the instance belongs to.
    replacate_id str
    The logical ID of the replica instance.
    resource_group_id str
    The ID of the resource group.
    search_key str
    The name of the instance.
    secondary_zone_id str
    (Optional, Available in 1.128.0+) The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.
    security_group_id str
    security_ip_group_attribute str
    security_ip_group_name str
    security_ips Sequence[str]
    ssl_enable str
    status str
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    tags Mapping[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"}.
    user_name str
    The username of the instance.
    vpc_auth_mode str
    vpc_cloud_instance_id str
    Connection port of the instance.
    vpc_id str
    Used to retrieve instances belong to specified VPC.
    vswitch_id str
    Used to retrieve instances belong to specified vswitch resources.
    zone_id str
    The ID of the zone.
    architectureType String
    The type of the architecture. Valid values: cluster, standard and SplitRW.
    autoRenew Boolean
    autoRenewPeriod Number
    availabilityZone String
    It has been deprecated from provider version 1.101.0 and zone_id instead.
    bandwidth Number
    Instance bandwidth limit. Unit: Mbit/s.
    capacity Number
    Capacity of the applied ApsaraDB for the instance. Unit: MB.
    chargeType String
    It has been deprecated from provider version 1.101.0 and payment_type instead.
    config Map<Any>
    The parameter configuration of the instance.
    connectionDomain String
    Instance connection domain (only Intranet access supported).
    connectionMode String
    The connection mode of the instance.
    connections Number
    IIt has been deprecated from provider version 1.101.0 and max_connections instead.
    createTime String
    Creation time of the instance.
    dbInstanceId String
    The ID of the instance.
    dbInstanceName String
    The name of the instance.
    destroyTime String
    The time when the instance was destroyed.
    endTime String
    Expiration time. Pay-As-You-Go instances are never expire.
    engineVersion String
    The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.
    expireTime String
    It has been deprecated from provider version 1.101.0 and end_time instead.
    hasRenewChangeOrder Boolean
    Indicates whether there was an order of renewal with configuration change that had not taken effect.
    id String
    The ID of the instance.
    instanceClass String
    Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.
    instanceReleaseProtection Boolean
    instanceType String
    The engine type of the KVStore DBInstance. Options are Memcache, and Redis. If no value is specified, all types are returned.
    isRds Boolean
    Indicates whether the instance is managed by Relational Database Service (RDS).
    maintainEndTime String
    maintainStartTime String
    maxConnections Number
    Instance connection quantity limit. Unit: count.
    name String
    It has been deprecated from provider version 1.101.0 and db_instance_name instead.
    networkType String
    The type of the network. Valid values: CLASSIC, VPC.
    nodeType String
    The node type of the instance.
    packageType String
    The type of the package.
    paymentType String
    The payment type. Valid values: PostPaid, PrePaid.
    port Number
    The service port of the instance.
    privateIp String
    Private IP address of the instance.
    qps Number
    The queries per second (QPS) supported by the instance.
    regionId String
    Region ID the instance belongs to.
    replacateId String
    The logical ID of the replica instance.
    resourceGroupId String
    The ID of the resource group.
    searchKey String
    The name of the instance.
    secondaryZoneId String
    (Optional, Available in 1.128.0+) The ID of the secondary zone to which you want to migrate the ApsaraDB for Redis instance.
    securityGroupId String
    securityIpGroupAttribute String
    securityIpGroupName String
    securityIps List<String>
    sslEnable String
    status String
    The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.
    tags Map<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"}.
    userName String
    The username of the instance.
    vpcAuthMode String
    vpcCloudInstanceId String
    Connection port of the instance.
    vpcId String
    Used to retrieve instances belong to specified VPC.
    vswitchId String
    Used to retrieve instances belong to specified vswitch resources.
    zoneId String
    The ID of the zone.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-alicloud