View Source AWS.ARCZonalShift (aws-elixir v1.0.7)

Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Application Recovery Controller (ARC).

You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.

You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.

For more information about using zonal shift and zonal autoshift, see the Amazon Application Recovery Controller Developer Guide.

Link to this section Summary

Functions

Cancel an in-progress practice run zonal shift in Amazon Application Recovery Controller.

Cancel a zonal shift in Amazon Application Recovery Controller.

A practice run configuration for zonal autoshift is required when you enable zonal autoshift.

Deletes the practice run configuration for a resource.

Returns the status of the autoshift observer notification.

Get information about a resource that's been registered for zonal shifts with Amazon Application Recovery Controller in this Amazon Web Services Region.

Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Application Recovery Controller, and information about them.

Lists all active and completed zonal shifts in Amazon Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region.

Start an on-demand practice run zonal shift in Amazon Application Recovery Controller.

You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.

Update the status of autoshift observer notification.

Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.

The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status.

Update an active zonal shift in Amazon Application Recovery Controller in your Amazon Web Services account.

Link to this section Functions

Link to this function

cancel_practice_run(client, zonal_shift_id, input, options \\ [])

View Source

Cancel an in-progress practice run zonal shift in Amazon Application Recovery Controller.

Link to this function

cancel_zonal_shift(client, zonal_shift_id, input, options \\ [])

View Source

Cancel a zonal shift in Amazon Application Recovery Controller.

To cancel the zonal shift, specify the zonal shift ID.

A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.

Link to this function

create_practice_run_configuration(client, input, options \\ [])

View Source

A practice run configuration for zonal autoshift is required when you enable zonal autoshift.

A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.

When a resource has a practice run configuration, ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.

For more information, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.

Link to this function

delete_practice_run_configuration(client, resource_identifier, input, options \\ [])

View Source

Deletes the practice run configuration for a resource.

Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.

Link to this function

get_autoshift_observer_notification_status(client, options \\ [])

View Source

Returns the status of the autoshift observer notification.

Autoshift observer notifications notify you through Amazon EventBridge when there is an autoshift event for zonal autoshift. The status can be ENABLED or DISABLED. When ENABLED, a notification is sent when an autoshift is triggered. When DISABLED, notifications are not sent.

Link to this function

get_managed_resource(client, resource_identifier, options \\ [])

View Source

Get information about a resource that's been registered for zonal shifts with Amazon Application Recovery Controller in this Amazon Web Services Region.

Resources that are registered for zonal shifts are managed resources in ARC. You can start zonal shifts and configure zonal autoshift for managed resources.

Link to this function

list_autoshifts(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

Returns the autoshifts for an Amazon Web Services Region.

By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.

Link to this function

list_managed_resources(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Application Recovery Controller, and information about them.

The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.

Link to this function

list_zonal_shifts(client, max_results \\ nil, next_token \\ nil, resource_identifier \\ nil, status \\ nil, options \\ [])

View Source

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.

Link to this function

start_practice_run(client, input, options \\ [])

View Source

Start an on-demand practice run zonal shift in Amazon Application Recovery Controller.

With zonal autoshift enabled, you can start an on-demand practice run to verify preparedness at any time. Amazon Web Services also runs automated practice runs about weekly when you have enabled zonal autoshift.

For more information, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.

Link to this function

start_zonal_shift(client, input, options \\ [])

View Source

You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.

You can start a zonal shift in ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with ARC by Amazon Web Services services.

Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:

When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.

For more information, see Zonal shift in the Amazon Application Recovery Controller Developer Guide.

Link to this function

update_autoshift_observer_notification_status(client, input, options \\ [])

View Source

Update the status of autoshift observer notification.

Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.

If the status is ENABLED, ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.

For more information, see Notifications for practice runs and autoshifts in the Amazon Application Recovery Controller Developer Guide.

Link to this function

update_practice_run_configuration(client, resource_identifier, input, options \\ [])

View Source

Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.

Link to this function

update_zonal_autoshift_configuration(client, resource_identifier, input, options \\ [])

View Source

The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status.

When a resource has a practice run configuation, ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.

You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.

Link to this function

update_zonal_shift(client, zonal_shift_id, input, options \\ [])

View Source

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.