Skip to content

CreateGlobalClusterMessage

Source code in docs_src/capo_docdb/types/create_global_cluster_message.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class CreateGlobalClusterMessage(TypedDict, closed=True):
    global_cluster_identifier: NotRequired[
        "capo_docdb.types.global_cluster_identifier.GlobalClusterIdentifier"
    ]
    """<p>The cluster identifier of the new global cluster.</p>"""
    source_db_cluster_identifier: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.</p>"""
    engine: NotRequired["capo_docdb.types.string.String"]
    """<p>The name of the database engine to be used for this cluster.</p>"""
    engine_version: NotRequired["capo_docdb.types.string.String"]
    """<p>The engine version of the global cluster.</p>"""
    deletion_protection: NotRequired[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ]
    """<p>The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled. </p>"""
    database_name: NotRequired["capo_docdb.types.string.String"]
    """<p>The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.</p>"""
    storage_encrypted: NotRequired["capo_docdb.types.boolean_optional.BooleanOptional"]
    """<p>The storage encryption setting for the new global cluster. </p>"""

database_name instance-attribute 

database_name: NotRequired[String]

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.

deletion_protection instance-attribute 

deletion_protection: NotRequired[BooleanOptional]

The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.

engine instance-attribute 

engine: NotRequired[String]

The name of the database engine to be used for this cluster.

engine_version instance-attribute 

engine_version: NotRequired[String]

The engine version of the global cluster.

global_cluster_identifier instance-attribute 

global_cluster_identifier: NotRequired[GlobalClusterIdentifier]

The cluster identifier of the new global cluster.

source_db_cluster_identifier instance-attribute 

source_db_cluster_identifier: NotRequired[String]

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

storage_encrypted instance-attribute 

storage_encrypted: NotRequired[BooleanOptional]

The storage encryption setting for the new global cluster.