Skip to content

DocumentDbConfiguration

Source code in docs_src/capo_arc_region_switch/types/document_db_configuration.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class DocumentDbConfiguration(TypedDict, closed=True):
    timeout_minutes: "int"
    """<p>The timeout value specified for the configuration.</p>"""
    cross_account_role: NotRequired[
        "capo_arc_region_switch.types.iam_role_arn.IamRoleArn"
    ]
    """<p>The cross account role for the configuration.</p>"""
    external_id: NotRequired["str"]
    """<p>The external ID (secret key) for the configuration.</p>"""
    behavior: "capo_arc_region_switch.types.document_db_default_behavior.DocumentDbDefaultBehavior"
    """<p>The behavior for a global cluster, that is, only allow switchover or also allow failover.</p>"""
    ungraceful: NotRequired[
        "capo_arc_region_switch.types.document_db_ungraceful.DocumentDbUngraceful"
    ]
    """<p>The settings for ungraceful execution.</p>"""
    global_cluster_identifier: "capo_arc_region_switch.types.document_db_global_cluster_identifier.DocumentDbGlobalClusterIdentifier"
    """<p>The global cluster identifier for a DocumentDB global cluster.</p>"""
    database_cluster_arns: (
        "capo_arc_region_switch.types.document_db_cluster_arns.DocumentDbClusterArns"
    )
    """<p>The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.</p>"""

behavior instance-attribute 

behavior: DocumentDbDefaultBehavior

The behavior for a global cluster, that is, only allow switchover or also allow failover.

cross_account_role instance-attribute 

cross_account_role: NotRequired[IamRoleArn]

The cross account role for the configuration.

database_cluster_arns instance-attribute 

database_cluster_arns: DocumentDbClusterArns

The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.

external_id instance-attribute 

external_id: NotRequired[str]

The external ID (secret key) for the configuration.

global_cluster_identifier instance-attribute 

global_cluster_identifier: DocumentDbGlobalClusterIdentifier

The global cluster identifier for a DocumentDB global cluster.

timeout_minutes instance-attribute 

timeout_minutes: int

The timeout value specified for the configuration.

ungraceful instance-attribute 

ungraceful: NotRequired[DocumentDbUngraceful]

The settings for ungraceful execution.