pulumi-alicloud-kotlin/com.pulumi.alicloud.gpdb.kotlin/GpdbFunctions/getInstances

getInstances

suspend fun getInstances(argument: GetInstancesPlainArgs): GetInstancesResult

This data source provides the AnalyticDB for PostgreSQL instances of the current Alibaba Cloud user.

NOTE: Available in 1.47.0+

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.gpdb.GpdbFunctions;
import com.pulumi.alicloud.gpdb.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 ids = GpdbFunctions.getInstances();
        ctx.export("gpdbDbInstanceId1", ids.applyValue(getInstancesResult -> getInstancesResult.instances()[0].id()));
    }
}
Content copied to clipboard

Return

A collection of values returned by getInstances.

Parameters

argument

A collection of arguments for invoking getInstances.

suspend fun getInstances(availabilityZone: String? = null, dbInstanceCategories: String? = null, dbInstanceModes: String? = null, description: String? = null, enableDetails: Boolean? = null, ids: List<String>? = null, instanceNetworkType: String? = null, nameRegex: String? = null, outputFile: String? = null, resourceGroupId: String? = null, status: String? = null, tags: Map<String, Any>? = null, vswitchId: String? = null): GetInstancesResult

Return

A collection of values returned by getInstances.

See also

Parameters

availabilityZone

Instance availability zone.

dbInstanceCategories

The db instance categories.

dbInstanceModes

The db instance modes.

description

The description of the instance.

enableDetails

Default to false. Set it to true can output more details about resource attributes.

ids

The ids list of AnalyticDB for PostgreSQL instances.

instanceNetworkType

The network type of the instance.

nameRegex

A regex string to apply to the instance name.

outputFile
resourceGroupId

The ID of the enterprise resource group to which the instance belongs.

status

The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.

tags

The tags of the instance.

vswitchId

The vswitch id.

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.gpdb.kotlin.inputs.GetInstancesPlainArgs.