com.amazonaws.services.arczonalshift

Class AWSARCZonalShiftClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.arczonalshift.AWSARCZonalShiftClient

All Implemented Interfaces:

AWSARCZonalShift

Direct Known Subclasses:

AWSARCZonalShiftAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSARCZonalShiftClient
extends AmazonWebServiceClient
implements AWSARCZonalShift

Client for accessing AWS ARC - Zonal Shift. All service calls made using this client are blocking, and will not return until the service call completes.

Welcome to the API Reference Guide for zonal shift and zonal autoshift in 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 supported load balancer resources. Zonal autoshift is a capability in Route 53 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.

To help make sure 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 away from an Availability Zone. Practice runs help you to 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.

Before you configure practice runs or enable zonal autoshift, we strongly recommend that you prescale your application resource capacity in all Availability Zones in the Region where your application resources are deployed. You should not rely on scaling on demand when an autoshift or practice run starts. Zonal autoshift, including practice runs, works independently, and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of pre-scaling, can result in loss of availability.

If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure the minimum capacity of your auto scaling to continue operating normally with the loss of an Availability Zone.

Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could potentially impact customers. In some cases, resources might be shifted away that are not experiencing impact.

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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.arczonalshift.AWSARCZonalShift

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSARCZonalShiftClientBuilder	builder()
CancelZonalShiftResult	cancelZonalShift(CancelZonalShiftRequest request) Cancel a zonal shift in Amazon Route 53 Application Recovery Controller.
CreatePracticeRunConfigurationResult	createPracticeRunConfiguration(CreatePracticeRunConfigurationRequest request) A practice run configuration for zonal autoshift is required when you enable zonal autoshift.
DeletePracticeRunConfigurationResult	deletePracticeRunConfiguration(DeletePracticeRunConfigurationRequest request) Deletes the practice run configuration for a resource.
GetAutoshiftObserverNotificationStatusResult	getAutoshiftObserverNotificationStatus(GetAutoshiftObserverNotificationStatusRequest request) Returns the status of autoshift observer notification.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetManagedResourceResult	getManagedResource(GetManagedResourceRequest 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.
ListAutoshiftsResult	listAutoshifts(ListAutoshiftsRequest request) Returns a list of autoshifts for an Amazon Web Services Region.
ListManagedResourcesResult	listManagedResources(ListManagedResourcesRequest 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.
ListZonalShiftsResult	listZonalShifts(ListZonalShiftsRequest 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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartZonalShiftResult	startZonalShift(StartZonalShiftRequest 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.
UpdateAutoshiftObserverNotificationStatusResult	updateAutoshiftObserverNotificationStatus(UpdateAutoshiftObserverNotificationStatusRequest request) Update the status of autoshift observer notification.
UpdatePracticeRunConfigurationResult	updatePracticeRunConfiguration(UpdatePracticeRunConfigurationRequest 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.
UpdateZonalAutoshiftConfigurationResult	updateZonalAutoshiftConfiguration(UpdateZonalAutoshiftConfigurationRequest request) The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status.
UpdateZonalShiftResult	updateZonalShift(UpdateZonalShiftRequest request) Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSARCZonalShiftClientBuilder builder()

cancelZonalShift

public CancelZonalShiftResult cancelZonalShift(CancelZonalShiftRequest 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.

Specified by:

cancelZonalShift in interface AWSARCZonalShift

Parameters:

cancelZonalShiftRequest -

Returns:

Result of the CancelZonalShift operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ResourceNotFoundException - The input requested a resource that was not found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

createPracticeRunConfiguration

public CreatePracticeRunConfigurationResult createPracticeRunConfiguration(CreatePracticeRunConfigurationRequest 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.

When a resource has a practice run configuration, Route 53 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 Route 53 Application Recovery Controller Developer Guide.

Specified by:

createPracticeRunConfiguration in interface AWSARCZonalShift

Parameters:

createPracticeRunConfigurationRequest -

Returns:

Result of the CreatePracticeRunConfiguration operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ResourceNotFoundException - The input requested a resource that was not found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

deletePracticeRunConfiguration

public DeletePracticeRunConfigurationResult deletePracticeRunConfiguration(DeletePracticeRunConfigurationRequest 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.

Specified by:

deletePracticeRunConfiguration in interface AWSARCZonalShift

Parameters:

deletePracticeRunConfigurationRequest -

Returns:

Result of the DeletePracticeRunConfiguration operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ResourceNotFoundException - The input requested a resource that was not found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

getAutoshiftObserverNotificationStatus

public GetAutoshiftObserverNotificationStatusResult getAutoshiftObserverNotificationStatus(GetAutoshiftObserverNotificationStatusRequest request)

Returns 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, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 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 Route 53 Application Recovery Controller Developer Guide.

Specified by:

getAutoshiftObserverNotificationStatus in interface AWSARCZonalShift

Parameters:

getAutoshiftObserverNotificationStatusRequest -

Returns:

Result of the GetAutoshiftObserverNotificationStatus operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

getManagedResource

public GetManagedResourceResult getManagedResource(GetManagedResourceRequest 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.

Specified by:

getManagedResource in interface AWSARCZonalShift

Parameters:

getManagedResourceRequest -

Returns:

Result of the GetManagedResource operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ResourceNotFoundException - The input requested a resource that was not found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listAutoshifts

public ListAutoshiftsResult listAutoshifts(ListAutoshiftsRequest request)

Returns a list of 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.

Specified by:

listAutoshifts in interface AWSARCZonalShift

Parameters:

listAutoshiftsRequest -

Returns:

Result of the ListAutoshifts operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listManagedResources

public ListManagedResourcesResult listManagedResources(ListManagedResourcesRequest 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.

Specified by:

listManagedResources in interface AWSARCZonalShift

Parameters:

listManagedResourcesRequest -

Returns:

Result of the ListManagedResources operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listZonalShifts

public ListZonalShiftsResult listZonalShifts(ListZonalShiftsRequest 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-initiated 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.

Specified by:

listZonalShifts in interface AWSARCZonalShift

Parameters:

listZonalShiftsRequest -

Returns:

Result of the ListZonalShifts operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

startZonalShift

public StartZonalShiftResult startZonalShift(StartZonalShiftRequest 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.

Specified by:

startZonalShift in interface AWSARCZonalShift

Parameters:

startZonalShiftRequest -

Returns:

Result of the StartZonalShift operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ResourceNotFoundException - The input requested a resource that was not found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

updateAutoshiftObserverNotificationStatus

public UpdateAutoshiftObserverNotificationStatusResult updateAutoshiftObserverNotificationStatus(UpdateAutoshiftObserverNotificationStatusRequest request)

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, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 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 Route 53 Application Recovery Controller Developer Guide.

Specified by:

updateAutoshiftObserverNotificationStatus in interface AWSARCZonalShift

Parameters:

updateAutoshiftObserverNotificationStatusRequest -

Returns:

Result of the UpdateAutoshiftObserverNotificationStatus operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

updatePracticeRunConfiguration

public UpdatePracticeRunConfigurationResult updatePracticeRunConfiguration(UpdatePracticeRunConfigurationRequest 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.

Specified by:

updatePracticeRunConfiguration in interface AWSARCZonalShift

Parameters:

updatePracticeRunConfigurationRequest -

Returns:

Result of the UpdatePracticeRunConfiguration operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ResourceNotFoundException - The input requested a resource that was not found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

updateZonalAutoshiftConfiguration

public UpdateZonalAutoshiftConfigurationResult updateZonalAutoshiftConfiguration(UpdateZonalAutoshiftConfigurationRequest request)

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, Route 53 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.

Specified by:

updateZonalAutoshiftConfiguration in interface AWSARCZonalShift

Parameters:

updateZonalAutoshiftConfigurationRequest -

Returns:

Result of the UpdateZonalAutoshiftConfiguration operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ResourceNotFoundException - The input requested a resource that was not found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

updateZonalShift

public UpdateZonalShiftResult updateZonalShift(UpdateZonalShiftRequest request)

Update an active zonal shift in Amazon Route 53 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.

Specified by:

updateZonalShift in interface AWSARCZonalShift

Parameters:

updateZonalShiftRequest -

Returns:

Result of the UpdateZonalShift operation returned by the service.

Throws:

InternalServerException - There was an internal server error.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ResourceNotFoundException - The input requested a resource that was not found.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSARCZonalShift

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSARCZonalShift

Overrides:

shutdown in class AmazonWebServiceClient