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/v2/go/aws/rds"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}
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",
}, { async: true }));

Using GetCluster

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function  get_cluster(cluster_identifier=None, tags=None, opts=None)
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)

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

public static class GetCluster {
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
}

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 {[key: string]: string}
cluster_identifier str

The cluster identifier of the RDS cluster.

tags Dict[str, str]

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 []string
BacktrackWindow int
BackupRetentionPeriod int
ClusterIdentifier string
ClusterMembers []string
ClusterResourceId string
DatabaseName string
DbClusterParameterGroupName string
DbSubnetGroupName string
EnabledCloudwatchLogsExports []string
Endpoint string
Engine string
EngineVersion string
FinalSnapshotIdentifier string
HostedZoneId string
IamDatabaseAuthenticationEnabled bool
IamRoles []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 map[string]string
VpcSecurityGroupIds []string
arn string
availabilityZones string[]
backtrackWindow number
backupRetentionPeriod number
clusterIdentifier string
clusterMembers string[]
clusterResourceId string
databaseName string
dbClusterParameterGroupName string
dbSubnetGroupName string
enabledCloudwatchLogsExports string[]
endpoint string
engine string
engineVersion string
finalSnapshotIdentifier string
hostedZoneId string
iamDatabaseAuthenticationEnabled boolean
iamRoles 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 {[key: string]: string}
vpcSecurityGroupIds string[]
arn str
availability_zones List[str]
backtrack_window float
backup_retention_period float
cluster_identifier str
cluster_members List[str]
cluster_resource_id str
database_name str
db_cluster_parameter_group_name str
db_subnet_group_name str
enabled_cloudwatch_logs_exports List[str]
endpoint str
engine str
engine_version str
final_snapshot_identifier str
hosted_zone_id str
iam_database_authentication_enabled bool
iam_roles List[str]
id str

The provider-assigned unique ID for this managed resource.

kms_key_id str
master_username str
port float
preferred_backup_window str
preferred_maintenance_window str
reader_endpoint str
replication_source_identifier str
storage_encrypted bool
tags Dict[str, str]
vpc_security_group_ids List[str]

Package Details

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