aws-native.docdb.getGlobalCluster

AWS Cloud Control v1.51.0, Feb 2 26

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.51.0 published on Monday, Feb 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.51.0 published on Monday, Feb 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Using getGlobalCluster

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 getGlobalCluster(args: GetGlobalClusterArgs, opts?: InvokeOptions): Promise<GetGlobalClusterResult>
function getGlobalClusterOutput(args: GetGlobalClusterOutputArgs, opts?: InvokeOptions): Output<GetGlobalClusterResult>

def get_global_cluster(global_cluster_identifier: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetGlobalClusterResult
def get_global_cluster_output(global_cluster_identifier: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetGlobalClusterResult]

func LookupGlobalCluster(ctx *Context, args *LookupGlobalClusterArgs, opts ...InvokeOption) (*LookupGlobalClusterResult, error)
func LookupGlobalClusterOutput(ctx *Context, args *LookupGlobalClusterOutputArgs, opts ...InvokeOption) LookupGlobalClusterResultOutput

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

public static class GetGlobalCluster 
{
    public static Task<GetGlobalClusterResult> InvokeAsync(GetGlobalClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetGlobalClusterResult> Invoke(GetGlobalClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGlobalClusterResult> getGlobalCluster(GetGlobalClusterArgs args, InvokeOptions options)
public static Output<GetGlobalClusterResult> getGlobalCluster(GetGlobalClusterArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:docdb:getGlobalCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

GlobalClusterIdentifier string: The cluster identifier of the global cluster.

GlobalClusterIdentifier string: The cluster identifier of the global cluster.

globalClusterIdentifier String: The cluster identifier of the global cluster.

globalClusterIdentifier string: The cluster identifier of the global cluster.

global_cluster_identifier str: The cluster identifier of the global cluster.

globalClusterIdentifier String: The cluster identifier of the global cluster.

getGlobalCluster Result

The following output properties are available:

DeletionProtection bool: Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
GlobalClusterArn string: The Amazon Resource Name (ARN) for the global cluster.
GlobalClusterResourceId string: The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
Tags List<Pulumi.AwsNative.Outputs.Tag>: The tags to be assigned to the Amazon DocumentDB resource.

DeletionProtection bool: Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
GlobalClusterArn string: The Amazon Resource Name (ARN) for the global cluster.
GlobalClusterResourceId string: The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
Tags Tag: The tags to be assigned to the Amazon DocumentDB resource.

deletionProtection Boolean: Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
globalClusterArn String: The Amazon Resource Name (ARN) for the global cluster.
globalClusterResourceId String: The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
tags List<Tag>: The tags to be assigned to the Amazon DocumentDB resource.

deletionProtection boolean: Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
globalClusterArn string: The Amazon Resource Name (ARN) for the global cluster.
globalClusterResourceId string: The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
tags Tag[]: The tags to be assigned to the Amazon DocumentDB resource.

deletion_protection bool: Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
global_cluster_arn str: The Amazon Resource Name (ARN) for the global cluster.
global_cluster_resource_id str: The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
tags Sequence[root_Tag]: The tags to be assigned to the Amazon DocumentDB resource.

deletionProtection Boolean: Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
globalClusterArn String: The Amazon Resource Name (ARN) for the global cluster.
globalClusterResourceId String: The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
tags List<Property Map>: The tags to be assigned to the Amazon DocumentDB resource.