getInstances function
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/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_rds_getinstances" "example" {
filters {
name = "db-instance-id"
values = ["my-database-id"]
}
}
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 com.pulumi.aws.rds.inputs.GetInstancesFilterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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/v7/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]string{
"Env": "test",
},
}, nil)
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_rds_getinstances" "example" {
tags = {
"Env" = "test"
}
}
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.ArrayList;
import java.util.Arrays;
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
args Arguments passed to this invoke. Arguments for getInstances.
options Invoke options controlling this call.
Implementation
Future<GetInstancesResult> getInstances(
GetInstancesArgs args, {
pulumi.InvokeOptions? options,
}) async {
final deployment = pulumi.Deployment.instance;
final result = await deployment.invoke<Map<String, dynamic>>(
'aws:rds/getInstances:getInstances',
args.toMap(),
options: pulumi.toDeploymentInvokeOptions(options),
);
return GetInstancesResult.fromMap(result);
}