ZonalShiftSummary
Lists information about zonal shifts in Amazon Route 53 Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that Route 53 ARC starts on your behalf for practice runs with zonal autoshift.
Zonal shifts are temporary, including customer-initiated zonal shifts and the zonal autoshift practice run zonal shifts that Route 53 ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A practice run zonal shift has a 30 minute duration.
Contents
- awayFrom
-
The Availability Zone (for example,
use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the AWS Region.Type: String
Length Constraints: Minimum length of 0. Maximum length of 20.
Required: Yes
- comment
-
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Required: Yes
- expiryTime
-
The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
Type: Timestamp
Required: Yes
- resourceIdentifier
-
The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 1024.
Required: Yes
- startTime
-
The time (UTC) when the zonal shift starts.
Type: Timestamp
Required: Yes
- status
-
A status for a zonal shift.
The
Statusfor a zonal shift can have one of the following values:-
ACTIVE: The zonal shift has been started and active.
-
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
-
CANCELED: The zonal shift was canceled.
Type: String
Valid Values:
ACTIVE | EXPIRED | CANCELEDRequired: Yes
-
- zonalShiftId
-
The identifier of a zonal shift.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 36.
Pattern:
^[A-Za-z0-9-]+$Required: Yes
- practiceRunOutcome
-
The outcome, or end state, of a practice run. The following values can be returned:
-
PENDING: Outcome value when the practice run is in progress.
-
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an
ALARMstate during the practice run, and the practice run was not interrupted before it completed. -
INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.
-
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an
ALARMstate during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
Type: String
Valid Values:
FAILED | INTERRUPTED | PENDING | SUCCEEDEDRequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
