MultiLocationConfig
A structure that contains information about the multi-location configuration of a canary, including whether it is a primary or replica, the primary location, and the list of replicas.
Contents
- LocationType
-
Indicates whether this canary is the
Primaryor aReplicain the multi-location configuration.Type: String
Valid Values:
Primary | ReplicaRequired: No
- PrimaryLocation
-
The Amazon Web Services Region where the primary canary is located.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern:
^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$Required: No
- Replicas
-
A list of replicas for this canary. This field is present only for the primary location canary.
Type: Array of Replica objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
- 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, andInconsistent.Type: String
Valid Values:
InProgress | InSync | InconsistentRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: