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

getInstances

suspend fun getInstances(argument: GetInstancesPlainArgs): GetInstancesResult

Data source for listing RDS Database Instances.

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.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 example = RdsFunctions.getInstances(GetInstancesArgs.builder()
            .filters(GetInstancesFilterArgs.builder()
                .name("db-instance-id")
                .values("my-database-id")
                .build())
            .build());
    }
}
Content copied to clipboard

Using tags

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.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 example = RdsFunctions.getInstances(GetInstancesArgs.builder()
            .tags(Map.of("Env", "test"))
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getInstances.

Parameters

argument

A collection of arguments for invoking getInstances.

suspend fun getInstances(filters: List<GetInstancesFilter>? = null, tags: Map<String, String>? = null): GetInstancesResult

Return

A collection of values returned by getInstances.

See also

Parameters

filters

Configuration block(s) used to filter instances with AWS supported attributes, such as engine, db-cluster-id or db-instance-id for example. Detailed below.

tags

Map of tags, each pair of which must exactly match a pair on the desired instances.

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

Return

A collection of values returned by getInstances.

See also

Parameters

argument

Builder for com.pulumi.aws.rds.kotlin.inputs.GetInstancesPlainArgs.