getInstances

Data source for listing RDS Database Instances.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.rds.getInstances({
filters: [{
name: "db-instance-id",
values: ["my-database-id"],
}],
});
import pulumi
import pulumi_aws as aws
example = aws.rds.get_instances(filters=[{
"name": "db-instance-id",
"values": ["my-database-id"],
}])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Rds.GetInstances.Invoke(new()
{
Filters = new[]
{
new Aws.Rds.Inputs.GetInstancesFilterInputArgs
{
Name = "db-instance-id",
Values = new[]
{
"my-database-id",
},
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.GetInstances(ctx, &rds.GetInstancesArgs{
Filters: []rds.GetInstancesFilter{
{
Name: "db-instance-id",
Values: []string{
"my-database-id",
},
},
},
}, nil)
if err != nil {
return err
}
return nil
})
}
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());
}
}
variables:
example:
fn::invoke:
function: aws:rds:getInstances
arguments:
filters:
- name: db-instance-id
values:
- my-database-id

Using tags

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.rds.getInstances({
tags: {
Env: "test",
},
});
import pulumi
import pulumi_aws as aws
example = aws.rds.get_instances(tags={
"Env": "test",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Rds.GetInstances.Invoke(new()
{
Tags =
{
{ "Env", "test" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.GetInstances(ctx, &rds.GetInstancesArgs{
Tags: map[string]interface{}{
"Env": "test",
},
}, nil)
if err != nil {
return err
}
return nil
})
}
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());
}
}
variables:
example:
fn::invoke:
function: aws:rds:getInstances
arguments:
tags:
Env: test

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.

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.

See also


Return

A collection of values returned by getInstances.

Parameters

argument

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

See also