AWS Classic v5.28.0, Jan 23 23

aws.rds.getInstances

Data source for listing RDS Database Instances.

Example Usage

Basic Usage

using System.Collections.Generic;
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/v5/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());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.rds.get_instances(filters=[aws.rds.GetInstancesFilterArgs(
    name="db-instance-id",
    values=["my-database-id"],
)])

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"],
    }],
});

variables:
  example:
    fn::invoke:
      Function: aws:rds:getInstances
      Arguments:
        filters:
          - name: db-instance-id
            values:
              - my-database-id

Using getInstances

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>

def get_instances(filters: Optional[Sequence[GetInstancesFilter]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetInstancesFilterArgs]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]

func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput

> Note: This function is named GetInstances in the Go SDK.

public static class GetInstances 
{
    public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:rds/getInstances:getInstances
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetInstancesFilter>: Configuration block(s) for filtering. Detailed below.

Filters []GetInstancesFilter: Configuration block(s) for filtering. Detailed below.

filters List<GetInstancesFilter>: Configuration block(s) for filtering. Detailed below.

filters GetInstancesFilter[]: Configuration block(s) for filtering. Detailed below.

filters Sequence[GetInstancesFilter]: Configuration block(s) for filtering. Detailed below.

filters List<Property Map>: Configuration block(s) for filtering. Detailed below.

getInstances Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
InstanceArns List<string>: ARNs of the matched RDS instances.
InstanceIdentifiers List<string>: Identifiers of the matched RDS instances.
Filters List<GetInstancesFilter>

Id string: The provider-assigned unique ID for this managed resource.
InstanceArns []string: ARNs of the matched RDS instances.
InstanceIdentifiers []string: Identifiers of the matched RDS instances.
Filters []GetInstancesFilter

id String: The provider-assigned unique ID for this managed resource.
instanceArns List<String>: ARNs of the matched RDS instances.
instanceIdentifiers List<String>: Identifiers of the matched RDS instances.
filters List<GetInstancesFilter>

id string: The provider-assigned unique ID for this managed resource.
instanceArns string[]: ARNs of the matched RDS instances.
instanceIdentifiers string[]: Identifiers of the matched RDS instances.
filters GetInstancesFilter[]

id str: The provider-assigned unique ID for this managed resource.
instance_arns Sequence[str]: ARNs of the matched RDS instances.
instance_identifiers Sequence[str]: Identifiers of the matched RDS instances.
filters Sequence[GetInstancesFilter]

id String: The provider-assigned unique ID for this managed resource.
instanceArns List<String>: ARNs of the matched RDS instances.
instanceIdentifiers List<String>: Identifiers of the matched RDS instances.
filters List<Property Map>

Supporting Types

GetInstancesFilter

Name string: Name of the filter field. Valid values can be found in the RDS DescribeDBClusters API Reference.
Values List<string>: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

Name string: Name of the filter field. Valid values can be found in the RDS DescribeDBClusters API Reference.
Values []string: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

name String: Name of the filter field. Valid values can be found in the RDS DescribeDBClusters API Reference.
values List<String>: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

name string: Name of the filter field. Valid values can be found in the RDS DescribeDBClusters API Reference.
values string[]: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

name str: Name of the filter field. Valid values can be found in the RDS DescribeDBClusters API Reference.
values Sequence[str]: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

name String: Name of the filter field. Valid values can be found in the RDS DescribeDBClusters API Reference.
values List<String>: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.