pulumi-alicloud-kotlin/com.pulumi.alicloud.rds.kotlin/RdsFunctions/getInstances

getInstances

suspend fun getInstances(argument: GetInstancesPlainArgs): GetInstancesResult

The alicloud.rds.getInstances data source provides a collection of RDS instances available in Alibaba Cloud 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.rds.RdsFunctions;
import com.pulumi.alicloud.rds.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 dbInstancesDs = RdsFunctions.getInstances(GetInstancesArgs.builder()
            .nameRegex("data-\\d+")
            .status("Running")
            .tags(Map.ofEntries(
                Map.entry("size", "tiny"),
                Map.entry("type", "database")
            ))
            .build());
        ctx.export("firstDbInstanceId", dbInstancesDs.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(connectionMode: String? = null, dbType: String? = null, enableDetails: Boolean? = null, engine: String? = null, ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, status: String? = null, tags: Map<String, Any>? = null, vpcId: String? = null, vswitchId: String? = null): GetInstancesResult

Return

A collection of values returned by getInstances.

See also

Parameters

connectionMode

Standard for standard access mode and Safe for high security access mode.

dbType

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

enableDetails

Default to false. Set it to true can output parameter template about resource attributes.

engine

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

ids

A list of RDS instance IDs.

nameRegex

A regex string to filter results by instance name.

outputFile
pageNumber
pageSize
status

Status of the instance.

tags

A map of tags assigned to the DB instances. Note: Before 1.60.0, the value's format is a json string which 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.

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