1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. docdb
  5. GlobalCluster

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

aws-native.docdb.GlobalCluster

aws-native logo

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

    The AWS::DocDB::GlobalCluster resource represents an Amazon DocumentDB Global Cluster.

    Create GlobalCluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GlobalCluster(name: string, args: GlobalClusterArgs, opts?: CustomResourceOptions);
    @overload
def GlobalCluster(resource_name: str,
                  args: GlobalClusterArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def GlobalCluster(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  global_cluster_identifier: Optional[str] = None,
                  deletion_protection: Optional[bool] = None,
                  engine: Optional[GlobalClusterEngine] = None,
                  engine_version: Optional[str] = None,
                  source_db_cluster_identifier: Optional[str] = None,
                  storage_encrypted: Optional[bool] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewGlobalCluster(ctx *Context, name string, args GlobalClusterArgs, opts ...ResourceOption) (*GlobalCluster, error)
    public GlobalCluster(string name, GlobalClusterArgs args, CustomResourceOptions? opts = null)
    public GlobalCluster(String name, GlobalClusterArgs args)
public GlobalCluster(String name, GlobalClusterArgs args, CustomResourceOptions options)

    type: aws-native:docdb:GlobalCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GlobalClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GlobalClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GlobalClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    GlobalCluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GlobalCluster resource accepts the following input properties:

    GlobalClusterIdentifier string
    The cluster identifier of the global cluster.
    DeletionProtection bool
    Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
    Engine Pulumi.AwsNative.DocDb.GlobalClusterEngine
    The database engine to use for this global cluster.
    EngineVersion string
    The engine version to use for this global cluster.
    SourceDbClusterIdentifier string
    The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted
    StorageEncrypted bool
    Indicates whether the global cluster has storage encryption enabled.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to be assigned to the Amazon DocumentDB resource.
    GlobalClusterIdentifier string
    The cluster identifier of the global cluster.
    DeletionProtection bool
    Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
    Engine GlobalClusterEngine
    The database engine to use for this global cluster.
    EngineVersion string
    The engine version to use for this global cluster.
    SourceDbClusterIdentifier string
    The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted
    StorageEncrypted bool
    Indicates whether the global cluster has storage encryption enabled.
    Tags TagArgs
    The tags to be assigned to the Amazon DocumentDB resource.
    globalClusterIdentifier String
    The cluster identifier of the global cluster.
    deletionProtection Boolean
    Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
    engine GlobalClusterEngine
    The database engine to use for this global cluster.
    engineVersion String
    The engine version to use for this global cluster.
    sourceDbClusterIdentifier String
    The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted
    storageEncrypted Boolean
    Indicates whether the global cluster has storage encryption enabled.
    tags List<Tag>
    The tags to be assigned to the Amazon DocumentDB resource.
    globalClusterIdentifier string
    The cluster identifier of the global cluster.
    deletionProtection boolean
    Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
    engine GlobalClusterEngine
    The database engine to use for this global cluster.
    engineVersion string
    The engine version to use for this global cluster.
    sourceDbClusterIdentifier string
    The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted
    storageEncrypted boolean
    Indicates whether the global cluster has storage encryption enabled.
    tags Tag[]
    The tags to be assigned to the Amazon DocumentDB resource.
    global_cluster_identifier str
    The cluster identifier of the global cluster.
    deletion_protection bool
    Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
    engine GlobalClusterEngine
    The database engine to use for this global cluster.
    engine_version str
    The engine version to use for this global cluster.
    source_db_cluster_identifier str
    The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted
    storage_encrypted bool
    Indicates whether the global cluster has storage encryption enabled.
    tags Sequence[TagArgs]
    The tags to be assigned to the Amazon DocumentDB resource.
    globalClusterIdentifier String
    The cluster identifier of the global cluster.
    deletionProtection Boolean
    Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
    engine ""
    The database engine to use for this global cluster.
    engineVersion String
    The engine version to use for this global cluster.
    sourceDbClusterIdentifier String
    The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted
    storageEncrypted Boolean
    Indicates whether the global cluster has storage encryption enabled.
    tags List<Property Map>
    The tags to be assigned to the Amazon DocumentDB resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GlobalCluster resource produces the following output properties:

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GlobalClusterEngine, GlobalClusterEngineArgs

    Docdb
    docdb
    GlobalClusterEngineDocdb
    docdb
    Docdb
    docdb
    Docdb
    docdb
    DOCDB
    docdb
    "docdb"
    docdb

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    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
      Meet Neo: Your AI Platform Teammate