Class: AWS.ARCZonalShift
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.ARCZonalShift
- Identifier:
- arczonalshift
- API Version:
- 2022-10-30
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Welcome to the Zonal Shift API Reference Guide for Amazon Route 53 Application Recovery Controller (Route 53 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 a load balancer resource. Zonal autoshift is a capability in Route 53 ARC where Amazon Web Services shifts away application resource traffic from an Availability Zone, on your behalf, to help reduce your time to recovery during events. Amazon Web Services shifts away traffic for resources that are enabled for zonal autoshift whenever Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.
To ensure that zonal autoshift is safe for your application, you must also configure practice runs when you enable zonal autoshift for a resource. Practice runs start weekly zonal shifts for a resource, to shift traffic for the resource out of an Availability Zone. Practice runs make sure, on a regular basis, that you have enough capacity in all the Availability Zones in an Amazon Web Services Region for your application to continue to operate normally when traffic for a resource is shifted away from one Availability Zone.
You must prescale resource capacity in all Availability Zones in the Region where your application is deployed, before you configure practice runs or enable zonal autoshift for a resource. You should not rely on scaling on demand when an autoshift or practice run starts.
For more information about using zonal shift and zonal autoshift, see the Amazon Route 53 Application Recovery Controller Developer Guide.
Sending a Request Using ARCZonalShift
var arczonalshift = new AWS.ARCZonalShift();
arczonalshift.cancelZonalShift(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the ARCZonalShift object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var arczonalshift = new AWS.ARCZonalShift({apiVersion: '2022-10-30'});
You can also set the API version globally in AWS.config.apiVersions
using
the arczonalshift service identifier:
AWS.config.apiVersions = {
arczonalshift: '2022-10-30',
// other service API versions
};
var arczonalshift = new AWS.ARCZonalShift();
Constructor Summary collapse
-
new AWS.ARCZonalShift(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
cancelZonalShift(params = {}, callback) ⇒ AWS.Request
Cancel a zonal shift in Amazon Route 53 Application Recovery Controller.
-
createPracticeRunConfiguration(params = {}, callback) ⇒ AWS.Request
A practice run configuration for zonal autoshift is required when you enable zonal autoshift.
-
deletePracticeRunConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes the practice run configuration for a resource.
-
getManagedResource(params = {}, callback) ⇒ AWS.Request
Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region.
-
listAutoshifts(params = {}, callback) ⇒ AWS.Request
Returns the active autoshifts for a specified resource.
.
-
listManagedResources(params = {}, callback) ⇒ AWS.Request
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them.
-
listZonalShifts(params = {}, callback) ⇒ AWS.Request
Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region.
-
startZonalShift(params = {}, callback) ⇒ AWS.Request
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.
-
updatePracticeRunConfiguration(params = {}, callback) ⇒ AWS.Request
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.
.
-
updateZonalAutoshiftConfiguration(params = {}, callback) ⇒ AWS.Request
You can update the zonal autoshift status for a resource, to enable or disable zonal autoshift.
-
updateZonalShift(params = {}, callback) ⇒ AWS.Request
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.ARCZonalShift(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
cancelZonalShift(params = {}, callback) ⇒ AWS.Request
Cancel a zonal shift in Amazon Route 53 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.
createPracticeRunConfiguration(params = {}, callback) ⇒ AWS.Request
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.
For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
deletePracticeRunConfiguration(params = {}, callback) ⇒ AWS.Request
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.
getManagedResource(params = {}, callback) ⇒ AWS.Request
Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
listAutoshifts(params = {}, callback) ⇒ AWS.Request
Returns the active autoshifts for a specified resource.
listManagedResources(params = {}, callback) ⇒ AWS.Request
Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 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.
listZonalShifts(params = {}, callback) ⇒ AWS.Request
Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts
returns customer-started zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.
The ListZonalShifts
operation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts.
startZonalShift(params = {}, callback) ⇒ AWS.Request
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 Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.
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.
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 Route 53 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 Route 53 Application Recovery Controller Developer Guide.
updatePracticeRunConfiguration(params = {}, callback) ⇒ AWS.Request
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.
updateZonalAutoshiftConfiguration(params = {}, callback) ⇒ AWS.Request
You can update the zonal autoshift status for a resource, to enable or disable zonal autoshift. When zonal autoshift is ENABLED
, Amazon Web Services shifts away resource traffic from an Availability Zone, on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.