pulumi-alicloud-kotlin/com.pulumi.alicloud.kvstore.kotlin/KvstoreFunctions/getInstances

getInstances

suspend fun getInstances(argument: GetInstancesPlainArgs): GetInstancesResult

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

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());
    }
}
Content copied to clipboard

Return

A collection of values returned by getInstances.

Parameters

argument

A collection of arguments for invoking getInstances.

suspend fun getInstances(architectureType: String? = null, editionType: String? = null, enableDetails: Boolean? = null, engineVersion: String? = null, expired: String? = null, globalInstance: Boolean? = null, ids: List<String>? = null, instanceClass: String? = null, instanceType: String? = null, nameRegex: String? = null, networkType: String? = null, outputFile: String? = null, paymentType: String? = null, resourceGroupId: String? = null, searchKey: String? = null, status: String? = null, tags: Map<String, Any>? = null, vpcId: String? = null, vswitchId: String? = null, zoneId: String? = null): GetInstancesResult

Return

A collection of values returned by getInstances.

See also

Parameters

architectureType

The type of the architecture. Valid values: cluster, standard and SplitRW.

editionType

Used to retrieve instances belong to specified vswitch resources. Valid values: Enterprise, Community.

enableDetails

Default to false. Set it to true can output more details.

engineVersion

The engine version. Valid values: 2.8, 4.0, 5.0, 6.0, 7.0.

expired

The expiration status of the instance.

globalInstance

Whether to create a distributed cache.

ids

A list of KVStore DBInstance IDs.

instanceClass

Type of the applied ApsaraDB for Redis instance. For more information, see Instance type table.

instanceType

The engine type of the KVStore DBInstance. Options are Memcache, and Redis. If no value is specified, all types are returned.

nameRegex

A regex string to apply to the instance name.

networkType

The type of the network. Valid values: CLASSIC, VPC.

outputFile

The name of file that can save the collection of instances after running pulumi preview.

paymentType

The payment type. Valid values: PostPaid, PrePaid.

resourceGroupId

The ID of the resource group.

searchKey

The name of the instance.

status

The status of the KVStore DBInstance. Valid values: Changing, CleaningUpExpiredData, Creating, Flushing, HASwitching, Inactive, MajorVersionUpgrading, Migrating, NetworkModifying, Normal, Rebooting, SSLModifying, Transforming, ZoneMigrating.

tags

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

Used to retrieve instances belong to specified VPC.

vswitchId

Used to retrieve instances belong to specified vswitch resources.

zoneId

The ID of the zone.

suspend fun getInstances(argument: suspend GetInstancesPlainArgsBuilder.() -> Unit): GetInstancesResult

Return

A collection of values returned by getInstances.

See also

Parameters

argument

Builder for com.pulumi.alicloud.kvstore.kotlin.inputs.GetInstancesPlainArgs.