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.

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 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 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 request) 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 request) 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 request) 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 request) 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 request) Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS 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 that you've started for a resource in your AWS account in an AWS Region.

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

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

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

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 AWS 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 the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.

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

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