Skip to content

ModifyGlobalClusterMessage

Source code in docs_src/capo_docdb/types/modify_global_cluster_message.py
class ModifyGlobalClusterMessage(TypedDict, closed=True):
    global_cluster_identifier: NotRequired[
        "capo_docdb.types.global_cluster_identifier.GlobalClusterIdentifier"
    ]
    """<p>The identifier for the global cluster being modified. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing global cluster.</p> </li> </ul>"""
    new_global_cluster_identifier: NotRequired[
        "capo_docdb.types.global_cluster_identifier.GlobalClusterIdentifier"
    ]
    """<p>The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens</p> <p>The first character must be a letter</p> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul> <p>Example: <code>my-cluster2</code> </p>"""
    deletion_protection: NotRequired[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled. </p>"""

deletion_protection instance-attribute

deletion_protection: NotRequired[BooleanOptional]

Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

global_cluster_identifier instance-attribute

global_cluster_identifier: NotRequired[GlobalClusterIdentifier]

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

Constraints:

  • Must match the identifier of an existing global cluster.

new_global_cluster_identifier instance-attribute

new_global_cluster_identifier: NotRequired[GlobalClusterIdentifier]

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