AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

getCluster

Provides information about an RDS cluster.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var clusterName = Output.Create(Aws.Rds.GetCluster.InvokeAsync(new Aws.Rds.GetClusterArgs
        {
            ClusterIdentifier = "clusterName",
        }));
    }

}
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.LookupCluster(ctx, &rds.LookupClusterArgs{
			ClusterIdentifier: "clusterName",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var clusterName = Output.of(RdsFunctions.getCluster(GetClusterArgs.builder()
            .clusterIdentifier("clusterName")
            .build()));

    }
}
import pulumi
import pulumi_aws as aws

cluster_name = aws.rds.get_cluster(cluster_identifier="clusterName")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const clusterName = pulumi.output(aws.rds.getCluster({
    clusterIdentifier: "clusterName",
}));
variables:
  clusterName:
    Fn::Invoke:
      Function: aws:rds:getCluster
      Arguments:
        clusterIdentifier: clusterName

Using getCluster

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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
def get_cluster(cluster_identifier: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_identifier: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:rds/getCluster:getCluster
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ClusterIdentifier string

The cluster identifier of the RDS cluster.

Tags Dictionary<string, string>
ClusterIdentifier string

The cluster identifier of the RDS cluster.

Tags map[string]string
clusterIdentifier String

The cluster identifier of the RDS cluster.

tags Map<String,String>
clusterIdentifier string

The cluster identifier of the RDS cluster.

tags {[key: string]: string}
cluster_identifier str

The cluster identifier of the RDS cluster.

tags Mapping[str, str]
clusterIdentifier String

The cluster identifier of the RDS cluster.

tags Map<String>

getCluster Result

The following output properties are available:

Arn string
AvailabilityZones List<string>
BacktrackWindow int
BackupRetentionPeriod int
ClusterIdentifier string
ClusterMembers List<string>
ClusterResourceId string
DatabaseName string
DbClusterParameterGroupName string
DbSubnetGroupName string
EnabledCloudwatchLogsExports List<string>
Endpoint string
Engine string
EngineVersion string
FinalSnapshotIdentifier string
HostedZoneId string
IamDatabaseAuthenticationEnabled bool
IamRoles List<string>
Id string

The provider-assigned unique ID for this managed resource.

KmsKeyId string
MasterUsername string
Port int
PreferredBackupWindow string
PreferredMaintenanceWindow string
ReaderEndpoint string
ReplicationSourceIdentifier string
StorageEncrypted bool
Tags Dictionary<string, string>
VpcSecurityGroupIds List<string>
arn String
availabilityZones List<String>
backtrackWindow Integer
backupRetentionPeriod Integer
clusterIdentifier String
clusterMembers List<String>
clusterResourceId String
databaseName String
dbClusterParameterGroupName String
dbSubnetGroupName String
enabledCloudwatchLogsExports List<String>
endpoint String
engine String
engineVersion String
finalSnapshotIdentifier String
hostedZoneId String
iamDatabaseAuthenticationEnabled Boolean
iamRoles List<String>
id String

The provider-assigned unique ID for this managed resource.

kmsKeyId String
masterUsername String
port Integer
preferredBackupWindow String
preferredMaintenanceWindow String
readerEndpoint String
replicationSourceIdentifier String
storageEncrypted Boolean
tags Map<String,String>
vpcSecurityGroupIds List<String>
arn String
availabilityZones List<String>
backtrackWindow Number
backupRetentionPeriod Number
clusterIdentifier String
clusterMembers List<String>
clusterResourceId String
databaseName String
dbClusterParameterGroupName String
dbSubnetGroupName String
enabledCloudwatchLogsExports List<String>
endpoint String
engine String
engineVersion String
finalSnapshotIdentifier String
hostedZoneId String
iamDatabaseAuthenticationEnabled Boolean
iamRoles List<String>
id String

The provider-assigned unique ID for this managed resource.

kmsKeyId String
masterUsername String
port Number
preferredBackupWindow String
preferredMaintenanceWindow String
readerEndpoint String
replicationSourceIdentifier String
storageEncrypted Boolean
tags Map<String>
vpcSecurityGroupIds List<String>

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.