Skip to content

MultiLocationConfig

Source code in docs_src/capo_synthetics/types/multi_location_config.py 
14
15
16
17
18
19
20
21
22
23
24
class MultiLocationConfig(TypedDict, closed=True):
    location_type: NotRequired["capo_synthetics.types.location_type.LocationType"]
    """<p>Indicates whether this canary is the <code>Primary</code> or a <code>Replica</code> in the multi-location configuration.</p>"""
    primary_location: NotRequired["capo_synthetics.types.location.Location"]
    """<p>The Amazon Web Services Region where the primary canary is located.</p>"""
    replicas: NotRequired["capo_synthetics.types.replicas.Replicas"]
    """<p>A list of replicas for this canary. This field is present only for the primary location canary.</p>"""
    replication_state: NotRequired[
        "capo_synthetics.types.replication_state.ReplicationState"
    ]
    """<p>The overall replication state of the canary across all replica locations. This field is present only for the primary location canary. Valid values are <code>InProgress</code>, <code>InSync</code>, and <code>Inconsistent</code>.</p>"""

location_type instance-attribute 

location_type: NotRequired[LocationType]

Indicates whether this canary is the Primary or a Replica in the multi-location configuration.

primary_location instance-attribute 

primary_location: NotRequired[Location]

The Amazon Web Services Region where the primary canary is located.

replicas instance-attribute 

replicas: NotRequired[Replicas]

A list of replicas for this canary. This field is present only for the primary location canary.

replication_state instance-attribute 

replication_state: NotRequired[ReplicationState]

The overall replication state of the canary across all replica locations. This field is present only for the primary location canary. Valid values are InProgress, InSync, and Inconsistent.