AWS Classic v6.4.0, Oct 3 23

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.4.0 published on Tuesday, Oct 3, 2023 by Pulumi

pulumi/pulumi-aws

aws.rds.getCluster

Explore with Pulumi AI

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.4.0 published on Tuesday, Oct 3, 2023 by Pulumi

pulumi/pulumi-aws

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var clusterName = Aws.Rds.GetCluster.Invoke(new()
    {
        ClusterIdentifier = "clusterName",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.rds.inputs.GetClusterArgs;
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 clusterName = 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 = 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: Cluster identifier of the RDS cluster.
Tags Dictionary<string, string>: A map of tags assigned to the resource.

ClusterIdentifier string: Cluster identifier of the RDS cluster.
Tags map[string]string: A map of tags assigned to the resource.

clusterIdentifier String: Cluster identifier of the RDS cluster.
tags Map<String,String>: A map of tags assigned to the resource.

clusterIdentifier string: Cluster identifier of the RDS cluster.
tags {[key: string]: string}: A map of tags assigned to the resource.

cluster_identifier str: Cluster identifier of the RDS cluster.
tags Mapping[str, str]: A map of tags assigned to the resource.

clusterIdentifier String: Cluster identifier of the RDS cluster.
tags Map<String>: A map of tags assigned to the resource.

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
DbSystemId string
EnabledCloudwatchLogsExports List<string>
Endpoint string
Engine string
EngineMode 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
MasterUserSecrets List<GetClusterMasterUserSecret>
MasterUsername string
NetworkType string
Port int
PreferredBackupWindow string
PreferredMaintenanceWindow string
ReaderEndpoint string
ReplicationSourceIdentifier string
StorageEncrypted bool
Tags Dictionary<string, string>: A map of tags assigned to the resource.
VpcSecurityGroupIds List<string>

Arn string
AvailabilityZones []string
BacktrackWindow int
BackupRetentionPeriod int
ClusterIdentifier string
ClusterMembers []string
ClusterResourceId string
DatabaseName string
DbClusterParameterGroupName string
DbSubnetGroupName string
DbSystemId string
EnabledCloudwatchLogsExports []string
Endpoint string
Engine string
EngineMode string
EngineVersion string
FinalSnapshotIdentifier string
HostedZoneId string
IamDatabaseAuthenticationEnabled bool
IamRoles []string
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyId string
MasterUserSecrets []GetClusterMasterUserSecret
MasterUsername string
NetworkType string
Port int
PreferredBackupWindow string
PreferredMaintenanceWindow string
ReaderEndpoint string
ReplicationSourceIdentifier string
StorageEncrypted bool
Tags map[string]string: A map of tags assigned to the resource.
VpcSecurityGroupIds []string

arn String
availabilityZones List<String>
backtrackWindow Integer
backupRetentionPeriod Integer
clusterIdentifier String
clusterMembers List<String>
clusterResourceId String
databaseName String
dbClusterParameterGroupName String
dbSubnetGroupName String
dbSystemId String
enabledCloudwatchLogsExports List<String>
endpoint String
engine String
engineMode 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
masterUserSecrets List<GetClusterMasterUserSecret>
masterUsername String
networkType String
port Integer
preferredBackupWindow String
preferredMaintenanceWindow String
readerEndpoint String
replicationSourceIdentifier String
storageEncrypted Boolean
tags Map<String,String>: A map of tags assigned to the resource.
vpcSecurityGroupIds List<String>

arn string
availabilityZones string[]
backtrackWindow number
backupRetentionPeriod number
clusterIdentifier string
clusterMembers string[]
clusterResourceId string
databaseName string
dbClusterParameterGroupName string
dbSubnetGroupName string
dbSystemId string
enabledCloudwatchLogsExports string[]
endpoint string
engine string
engineMode string
engineVersion string
finalSnapshotIdentifier string
hostedZoneId string
iamDatabaseAuthenticationEnabled boolean
iamRoles string[]
id string: The provider-assigned unique ID for this managed resource.
kmsKeyId string
masterUserSecrets GetClusterMasterUserSecret[]
masterUsername string
networkType string
port number
preferredBackupWindow string
preferredMaintenanceWindow string
readerEndpoint string
replicationSourceIdentifier string
storageEncrypted boolean
tags {[key: string]: string}: A map of tags assigned to the resource.
vpcSecurityGroupIds string[]

arn str
availability_zones Sequence[str]
backtrack_window int
backup_retention_period int
cluster_identifier str
cluster_members Sequence[str]
cluster_resource_id str
database_name str
db_cluster_parameter_group_name str
db_subnet_group_name str
db_system_id str
enabled_cloudwatch_logs_exports Sequence[str]
endpoint str
engine str
engine_mode str
engine_version str
final_snapshot_identifier str
hosted_zone_id str
iam_database_authentication_enabled bool
iam_roles Sequence[str]
id str: The provider-assigned unique ID for this managed resource.
kms_key_id str
master_user_secrets Sequence[GetClusterMasterUserSecret]
master_username str
network_type str
port int
preferred_backup_window str
preferred_maintenance_window str
reader_endpoint str
replication_source_identifier str
storage_encrypted bool
tags Mapping[str, str]: A map of tags assigned to the resource.
vpc_security_group_ids Sequence[str]

arn String
availabilityZones List<String>
backtrackWindow Number
backupRetentionPeriod Number
clusterIdentifier String
clusterMembers List<String>
clusterResourceId String
databaseName String
dbClusterParameterGroupName String
dbSubnetGroupName String
dbSystemId String
enabledCloudwatchLogsExports List<String>
endpoint String
engine String
engineMode 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
masterUserSecrets List<Property Map>
masterUsername String
networkType String
port Number
preferredBackupWindow String
preferredMaintenanceWindow String
readerEndpoint String
replicationSourceIdentifier String
storageEncrypted Boolean
tags Map<String>: A map of tags assigned to the resource.
vpcSecurityGroupIds List<String>

Supporting Types

GetClusterMasterUserSecret

KmsKeyId string
SecretArn string
SecretStatus string

KmsKeyId string
SecretArn string
SecretStatus string

kmsKeyId String
secretArn String
secretStatus String

kmsKeyId string
secretArn string
secretStatus string

kms_key_id str
secret_arn str
secret_status str

kmsKeyId String
secretArn String
secretStatus String

Package Details

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

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.4.0 published on Tuesday, Oct 3, 2023 by Pulumi

pulumi/pulumi-aws

aws.rds.getCluster

On this page

On this page

Example Usage

Using getCluster

getCluster Result

Supporting Types

GetClusterMasterUserSecret

Package Details

On this page

On this page