modify_global_cluster

DocDB.Client.modify_global_cluster(**kwargs)

Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.

Note

This action only applies to Amazon DocumentDB clusters.

See also: AWS API Documentation

Request Syntax

response = client.modify_global_cluster(
    GlobalClusterIdentifier='string',
    NewGlobalClusterIdentifier='string',
    DeletionProtection=True|False
)

Parameters

• GlobalClusterIdentifier (string) --

  [REQUIRED]

  The identifier for the global cluster being modified. This parameter isn't case-sensitive.

  Constraints:

  • Must match the identifier of an existing global cluster.
• NewGlobalClusterIdentifier (string) --

  The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

  • Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can't end with a hyphen or contain two consecutive hyphens

  Example: my-cluster2

• DeletionProtection (boolean) -- Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

Return type

dict

Returns

Response Syntax

{
    'GlobalCluster': {
        'GlobalClusterIdentifier': 'string',
        'GlobalClusterResourceId': 'string',
        'GlobalClusterArn': 'string',
        'Status': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'DatabaseName': 'string',
        'StorageEncrypted': True|False,
        'DeletionProtection': True|False,
        'GlobalClusterMembers': [
            {
                'DBClusterArn': 'string',
                'Readers': [
                    'string',
                ],
                'IsWriter': True|False
            },
        ]
    }
}

Response Structure

• (dict) --

  • GlobalCluster (dict) --

    A data type representing an Amazon DocumentDB global cluster.

    • GlobalClusterIdentifier (string) --

      Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

    • GlobalClusterResourceId (string) --

      The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

    • GlobalClusterArn (string) --

      The Amazon Resource Name (ARN) for the global cluster.

    • Status (string) --

      Specifies the current state of this global cluster.

    • Engine (string) --

      The Amazon DocumentDB database engine used by the global cluster.

    • EngineVersion (string) --

      Indicates the database engine version.

    • DatabaseName (string) --

      The default database name within the new global cluster.

    • StorageEncrypted (boolean) --

      The storage encryption setting for the global cluster.

    • DeletionProtection (boolean) --

      The deletion protection setting for the new global cluster.

    • GlobalClusterMembers (list) --

      The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

      • (dict) --

        A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

        • DBClusterArn (string) --

          The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

        • Readers (list) --

          The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

          • (string) --

        • IsWriter (boolean) --

          Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

Exceptions

• DocDB.Client.exceptions.GlobalClusterNotFoundFault
• DocDB.Client.exceptions.InvalidGlobalClusterStateFault