zonal_shifts
Creates, updates, deletes, gets or lists a zonal_shifts resource.
Overview
| Name | zonal_shifts |
| Type | Resource |
| Id | aws.arc_zonal_shift.zonal_shifts |
Fields
The following fields are returned by SELECT queries:
- list_zonal_shifts
| Name | Datatype | Description |
|---|---|---|
away_from | string | 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 Amazon Web Services Region. |
comment | string | 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. |
expiry_time | string (date-time) | 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 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. |
practice_run_outcome | string | 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 ALARM state 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 ALARM state during the practice run, and the practice run was not interrupted before it completed. CAPACITY_CHECK_FAILED: The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed. For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide. (FAILED, INTERRUPTED, PENDING, SUCCEEDED, CAPACITY_CHECK_FAILED) |
resource_identifier | string | The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource. Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift: Amazon EC2 Auto Scaling groups Amazon Elastic Kubernetes Service Application Load Balancers Network Load Balancers |
shift_type | string | Defines the zonal shift type. (ZONAL_SHIFT, PRACTICE_RUN, FIS_EXPERIMENT, ZONAL_AUTOSHIFT) |
start_time | string (date-time) | The time (UTC) when the zonal shift starts. |
status | string | A status for a zonal shift. The Status for a zonal shift can have one of the following values: ACTIVE: The zonal shift has been started and is active. EXPIRED: The zonal shift has expired (the expiry time was exceeded). CANCELED: The zonal shift was canceled. (ACTIVE, EXPIRED, CANCELED) |
zonal_shift_id | string | The identifier of a zonal shift. (pattern: <code>[A-Za-z0-9-]+</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_zonal_shifts | select | region | nextToken, status, maxResults, resourceIdentifier | Lists all active and completed zonal shifts in Amazon Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that ARC started on your behalf for zonal autoshift. For more information about listing autoshifts, see ">ListAutoshifts. |
update_zonal_shift | update | zonal_shift_id, region | Update an active zonal shift in Amazon Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
zonal_shift_id | string | The identifier of a zonal shift. |
maxResults | integer | The number of objects that you want to return with this call. |
nextToken | string | Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results. |
resourceIdentifier | string | The identifier for the resource that you want to list zonal shifts for. The identifier is the Amazon Resource Name (ARN) for the resource. |
status | string | A status for a zonal shift. The Status for a zonal shift can have one of the following values: ACTIVE: The zonal shift has been started and is active. EXPIRED: The zonal shift has expired (the expiry time was exceeded). CANCELED: The zonal shift was canceled. |
SELECT examples
- list_zonal_shifts
Lists all active and completed zonal shifts in Amazon Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that ARC started on your behalf for zonal autoshift. For more information about listing autoshifts, see ">ListAutoshifts.
SELECT
away_from,
comment,
expiry_time,
practice_run_outcome,
resource_identifier,
shift_type,
start_time,
status,
zonal_shift_id
FROM aws.arc_zonal_shift.zonal_shifts
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND status = '{{ status }}'
AND maxResults = '{{ maxResults }}'
AND resourceIdentifier = '{{ resourceIdentifier }}'
;
UPDATE examples
- update_zonal_shift
Update an active zonal shift in Amazon Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
UPDATE aws.arc_zonal_shift.zonal_shifts
SET
comment = '{{ comment }}',
expiresIn = '{{ expiresIn }}'
WHERE
zonal_shift_id = '{{ zonal_shift_id }}' --required
AND region = '{{ region }}' --required
RETURNING
away_from,
comment,
expiry_time,
resource_identifier,
start_time,
status,
zonal_shift_id;