github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/rds/getClusters.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package rds
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Data source for managing an AWS RDS (Relational Database) Clusters.
    15  //
    16  // ## Example Usage
    17  //
    18  // ### Basic Usage
    19  //
    20  // <!--Start PulumiCodeChooser -->
    21  // ```go
    22  // package main
    23  //
    24  // import (
    25  //
    26  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
    27  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    28  //
    29  // )
    30  //
    31  //	func main() {
    32  //		pulumi.Run(func(ctx *pulumi.Context) error {
    33  //			_, err := rds.GetClusters(ctx, &rds.GetClustersArgs{
    34  //				Filters: []rds.GetClustersFilter{
    35  //					{
    36  //						Name: "engine",
    37  //						Values: []string{
    38  //							"aurora-postgresql",
    39  //						},
    40  //					},
    41  //				},
    42  //			}, nil)
    43  //			if err != nil {
    44  //				return err
    45  //			}
    46  //			return nil
    47  //		})
    48  //	}
    49  //
    50  // ```
    51  // <!--End PulumiCodeChooser -->
    52  func GetClusters(ctx *pulumi.Context, args *GetClustersArgs, opts ...pulumi.InvokeOption) (*GetClustersResult, error) {
    53  	opts = internal.PkgInvokeDefaultOpts(opts)
    54  	var rv GetClustersResult
    55  	err := ctx.Invoke("aws:rds/getClusters:getClusters", args, &rv, opts...)
    56  	if err != nil {
    57  		return nil, err
    58  	}
    59  	return &rv, nil
    60  }
    61  
    62  // A collection of arguments for invoking getClusters.
    63  type GetClustersArgs struct {
    64  	// Configuration block(s) for filtering. Detailed below.
    65  	Filters []GetClustersFilter `pulumi:"filters"`
    66  }
    67  
    68  // A collection of values returned by getClusters.
    69  type GetClustersResult struct {
    70  	// Set of cluster ARNs of the matched RDS clusters.
    71  	ClusterArns []string `pulumi:"clusterArns"`
    72  	// Set of ARNs of cluster identifiers of the matched RDS clusters.
    73  	ClusterIdentifiers []string            `pulumi:"clusterIdentifiers"`
    74  	Filters            []GetClustersFilter `pulumi:"filters"`
    75  	// The provider-assigned unique ID for this managed resource.
    76  	Id string `pulumi:"id"`
    77  }
    78  
    79  func GetClustersOutput(ctx *pulumi.Context, args GetClustersOutputArgs, opts ...pulumi.InvokeOption) GetClustersResultOutput {
    80  	return pulumi.ToOutputWithContext(context.Background(), args).
    81  		ApplyT(func(v interface{}) (GetClustersResult, error) {
    82  			args := v.(GetClustersArgs)
    83  			r, err := GetClusters(ctx, &args, opts...)
    84  			var s GetClustersResult
    85  			if r != nil {
    86  				s = *r
    87  			}
    88  			return s, err
    89  		}).(GetClustersResultOutput)
    90  }
    91  
    92  // A collection of arguments for invoking getClusters.
    93  type GetClustersOutputArgs struct {
    94  	// Configuration block(s) for filtering. Detailed below.
    95  	Filters GetClustersFilterArrayInput `pulumi:"filters"`
    96  }
    97  
    98  func (GetClustersOutputArgs) ElementType() reflect.Type {
    99  	return reflect.TypeOf((*GetClustersArgs)(nil)).Elem()
   100  }
   101  
   102  // A collection of values returned by getClusters.
   103  type GetClustersResultOutput struct{ *pulumi.OutputState }
   104  
   105  func (GetClustersResultOutput) ElementType() reflect.Type {
   106  	return reflect.TypeOf((*GetClustersResult)(nil)).Elem()
   107  }
   108  
   109  func (o GetClustersResultOutput) ToGetClustersResultOutput() GetClustersResultOutput {
   110  	return o
   111  }
   112  
   113  func (o GetClustersResultOutput) ToGetClustersResultOutputWithContext(ctx context.Context) GetClustersResultOutput {
   114  	return o
   115  }
   116  
   117  // Set of cluster ARNs of the matched RDS clusters.
   118  func (o GetClustersResultOutput) ClusterArns() pulumi.StringArrayOutput {
   119  	return o.ApplyT(func(v GetClustersResult) []string { return v.ClusterArns }).(pulumi.StringArrayOutput)
   120  }
   121  
   122  // Set of ARNs of cluster identifiers of the matched RDS clusters.
   123  func (o GetClustersResultOutput) ClusterIdentifiers() pulumi.StringArrayOutput {
   124  	return o.ApplyT(func(v GetClustersResult) []string { return v.ClusterIdentifiers }).(pulumi.StringArrayOutput)
   125  }
   126  
   127  func (o GetClustersResultOutput) Filters() GetClustersFilterArrayOutput {
   128  	return o.ApplyT(func(v GetClustersResult) []GetClustersFilter { return v.Filters }).(GetClustersFilterArrayOutput)
   129  }
   130  
   131  // The provider-assigned unique ID for this managed resource.
   132  func (o GetClustersResultOutput) Id() pulumi.StringOutput {
   133  	return o.ApplyT(func(v GetClustersResult) string { return v.Id }).(pulumi.StringOutput)
   134  }
   135  
   136  func init() {
   137  	pulumi.RegisterOutputType(GetClustersResultOutput{})
   138  }