com.amazonaws.services.arczonalshift

Interface AWSARCZonalShift

All Known Subinterfaces:

AWSARCZonalShiftAsync

All Known Implementing Classes:

AbstractAWSARCZonalShift, AbstractAWSARCZonalShiftAsync, AWSARCZonalShiftAsyncClient, AWSARCZonalShiftClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSARCZonalShift

Interface for accessing AWS ARC - Zonal Shift.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSARCZonalShift instead.

This is the API Reference Guide for the zonal shift feature of Amazon Route 53 Application Recovery Controller. This guide is for developers who need detailed information about zonal shift API actions, data types, and errors.

Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.

Zonal shift in Route 53 ARC enables you to move traffic for a load balancer resource away from an Availability Zone. Starting a zonal shift helps your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone, reducing the impact and time lost from an issue in one zone.

Supported AWS resources are automatically registered with Route 53 ARC. Resources that are registered for zonal shifts in Route 53 ARC are managed resources in Route 53 ARC. You can start a zonal shift for any managed resource in your account in a Region. 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.

Zonal shifts are temporary. You must specify an expiration when you start a zonal shift, of up to three days initially. If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelZonalShiftResult	cancelZonalShift(CancelZonalShiftRequest cancelZonalShiftRequest) Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region.
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 getManagedResourceRequest) Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS Region.
ListManagedResourcesResult	listManagedResources(ListManagedResourcesRequest listManagedResourcesRequest) Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them.
ListZonalShiftsResult	listZonalShifts(ListZonalShiftsRequest listZonalShiftsRequest) Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartZonalShiftResult	startZonalShift(StartZonalShiftRequest startZonalShiftRequest) You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone.
UpdateZonalShiftResult	updateZonalShift(UpdateZonalShiftRequest updateZonalShiftRequest) Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelZonalShift

CancelZonalShiftResult cancelZonalShift(CancelZonalShiftRequest cancelZonalShiftRequest)

Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region.

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 AWS service.

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

See Also:

AWS API Documentation

getManagedResource

GetManagedResourceResult getManagedResource(GetManagedResourceRequest getManagedResourceRequest)

Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC.

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.

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 AWS service.

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

See Also:

AWS API Documentation

listManagedResources

ListManagedResourcesResult listManagedResources(ListManagedResourcesRequest listManagedResourcesRequest)

Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are deployed in, and the resource name.

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 AWS service.

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

See Also:

AWS API Documentation

listZonalShifts

ListZonalShiftsResult listZonalShifts(ListZonalShiftsRequest listZonalShiftsRequest)

Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.

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 AWS service.

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

See Also:

AWS API Documentation

startZonalShift

StartZonalShiftResult startZonalShift(StartZonalShiftRequest startZonalShiftRequest)

You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your account in an AWS Region. Resources are automatically registered with Route 53 ARC by AWS 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.

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 AWS service.

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

See Also:

AWS API Documentation

updateZonalShift

UpdateZonalShiftResult updateZonalShift(UpdateZonalShiftRequest updateZonalShiftRequest)

Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.

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 AWS service.

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

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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