getClusters function

Future<GetClustersResult> getClusters(
  1. GetClustersArgs args, {
  2. InvokeOptions? options,
})

Data source for managing an AWS RDS (Relational Database) Clusters.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.rds.getClusters({
    filters: [{
        name: "engine",
        values: ["aurora-postgresql"],
    }],
});
import pulumi
import pulumi_aws as aws

example = aws.rds.get_clusters(filters=[{
    "name": "engine",
    "values": ["aurora-postgresql"],
}])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.Rds.GetClusters.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Rds.Inputs.GetClustersFilterInputArgs
            {
                Name = "engine",
                Values = new[]
                {
                    "aurora-postgresql",
                },
            },
        },
    });

});
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.GetClusters(ctx, &rds.GetClustersArgs{
			Filters: []rds.GetClustersFilter{
				{
					Name: "engine",
					Values: []string{
						"aurora-postgresql",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_rds_getclusters" "example" {
  filters {
    name   = "engine"
    values = ["aurora-postgresql"]
  }
}
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.GetClustersArgs;
import com.pulumi.aws.rds.inputs.GetClustersFilterArgs;
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.getClusters(GetClustersArgs.builder()
            .filters(GetClustersFilterArgs.builder()
                .name("engine")
                .values("aurora-postgresql")
                .build())
            .build());

    }
}
variables:
  example:
    fn::invoke:
      function: aws:rds:getClusters
      arguments:
        filters:
          - name: engine
            values:
              - aurora-postgresql

args Arguments passed to this invoke. Arguments for getClusters. options Invoke options controlling this call.

Implementation

Future<GetClustersResult> getClusters(
  GetClustersArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:rds/getClusters:getClusters',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetClustersResult.fromMap(result);
}