All Superinterfaces:: AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ArcZonalShiftClient extends AwsClient

Service client for accessing AWS ARC - Zonal Shift. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type

Field

Description

static final String

SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

static final String

SERVICE_NAME
Method Summary

Modifier and Type

Method

Description

static ArcZonalShiftClientBuilder

builder()

Create a builder that can be used to configure and create a ArcZonalShiftClient.

default CancelZonalShiftResponse

cancelZonalShift(Consumer<CancelZonalShiftRequest.Builder> cancelZonalShiftRequest)

Cancel a zonal shift in Amazon Route 53 Application Recovery Controller.

default CancelZonalShiftResponse

cancelZonalShift(CancelZonalShiftRequest cancelZonalShiftRequest)

Cancel a zonal shift in Amazon Route 53 Application Recovery Controller.

static ArcZonalShiftClient

create()

Create a ArcZonalShiftClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

default CreatePracticeRunConfigurationResponse

createPracticeRunConfiguration(Consumer<CreatePracticeRunConfigurationRequest.Builder> createPracticeRunConfigurationRequest)

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

default CreatePracticeRunConfigurationResponse

createPracticeRunConfiguration(CreatePracticeRunConfigurationRequest createPracticeRunConfigurationRequest)

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

default DeletePracticeRunConfigurationResponse

deletePracticeRunConfiguration(Consumer<DeletePracticeRunConfigurationRequest.Builder> deletePracticeRunConfigurationRequest)

Deletes the practice run configuration for a resource.

default DeletePracticeRunConfigurationResponse

deletePracticeRunConfiguration(DeletePracticeRunConfigurationRequest deletePracticeRunConfigurationRequest)

Deletes the practice run configuration for a resource.

default GetManagedResourceResponse

getManagedResource(Consumer<GetManagedResourceRequest.Builder> getManagedResourceRequest)

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.

default GetManagedResourceResponse

getManagedResource(GetManagedResourceRequest getManagedResourceRequest)

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.

default ListAutoshiftsResponse

listAutoshifts(Consumer<ListAutoshiftsRequest.Builder> listAutoshiftsRequest)

Returns the active autoshifts for a specified resource.

default ListAutoshiftsResponse

listAutoshifts(ListAutoshiftsRequest listAutoshiftsRequest)

Returns the active autoshifts for a specified resource.

default ListAutoshiftsIterable

listAutoshiftsPaginator(Consumer<ListAutoshiftsRequest.Builder> listAutoshiftsRequest)

This is a variant of listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest) operation.

default ListAutoshiftsIterable

listAutoshiftsPaginator(ListAutoshiftsRequest listAutoshiftsRequest)

This is a variant of listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest) operation.

default ListManagedResourcesResponse

listManagedResources(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest)

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.

default ListManagedResourcesResponse

listManagedResources(ListManagedResourcesRequest listManagedResourcesRequest)

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.

default ListManagedResourcesIterable

listManagedResourcesPaginator(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest)

This is a variant of listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest) operation.

default ListManagedResourcesIterable

listManagedResourcesPaginator(ListManagedResourcesRequest listManagedResourcesRequest)

This is a variant of listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest) operation.

default ListZonalShiftsResponse

listZonalShifts(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest)

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.

default ListZonalShiftsResponse

listZonalShifts(ListZonalShiftsRequest listZonalShiftsRequest)

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.

default ListZonalShiftsIterable

listZonalShiftsPaginator(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest)

This is a variant of listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) operation.

default ListZonalShiftsIterable

listZonalShiftsPaginator(ListZonalShiftsRequest listZonalShiftsRequest)

This is a variant of listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) operation.

default ArcZonalShiftServiceClientConfiguration

serviceClientConfiguration()

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

static ServiceMetadata

serviceMetadata()

default StartZonalShiftResponse

startZonalShift(Consumer<StartZonalShiftRequest.Builder> startZonalShiftRequest)

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.

default StartZonalShiftResponse

startZonalShift(StartZonalShiftRequest startZonalShiftRequest)

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.

default UpdatePracticeRunConfigurationResponse

updatePracticeRunConfiguration(Consumer<UpdatePracticeRunConfigurationRequest.Builder> updatePracticeRunConfigurationRequest)

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.

default UpdatePracticeRunConfigurationResponse

updatePracticeRunConfiguration(UpdatePracticeRunConfigurationRequest updatePracticeRunConfigurationRequest)

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.

default UpdateZonalAutoshiftConfigurationResponse

updateZonalAutoshiftConfiguration(Consumer<UpdateZonalAutoshiftConfigurationRequest.Builder> updateZonalAutoshiftConfigurationRequest)

You can update the zonal autoshift status for a resource, to enable or disable zonal autoshift.

default UpdateZonalAutoshiftConfigurationResponse

updateZonalAutoshiftConfiguration(UpdateZonalAutoshiftConfigurationRequest updateZonalAutoshiftConfigurationRequest)

You can update the zonal autoshift status for a resource, to enable or disable zonal autoshift.

default UpdateZonalShiftResponse

updateZonalShift(Consumer<UpdateZonalShiftRequest.Builder> updateZonalShiftRequest)

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

default UpdateZonalShiftResponse

updateZonalShift(UpdateZonalShiftRequest updateZonalShiftRequest)

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

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close

Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName

Field Details
- SERVICE_NAME
  
  static final String SERVICE_NAME
  See Also:
  
  Constant Field Values
- SERVICE_METADATA_ID
  
  static final String SERVICE_METADATA_ID
  
  Value for looking up the service's metadata from the ServiceMetadataProvider.
  See Also:
  
  Constant Field Values
Method Details
- cancelZonalShift
  
  default CancelZonalShiftResponse cancelZonalShift(CancelZonalShiftRequest cancelZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  Parameters:
  
  cancelZonalShiftRequest -
  
  Returns:
  
  Result of the CancelZonalShift operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- cancelZonalShift
  
  default CancelZonalShiftResponse cancelZonalShift(Consumer<CancelZonalShiftRequest.Builder> cancelZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  
  This is a convenience which creates an instance of the CancelZonalShiftRequest.Builder avoiding the need to create one manually via CancelZonalShiftRequest.builder()
  Parameters:
  
  cancelZonalShiftRequest - A Consumer that will call methods on CancelZonalShiftRequest.Builder to create a request.
  
  Returns:
  
  Result of the CancelZonalShift operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createPracticeRunConfiguration
  
  default CreatePracticeRunConfigurationResponse createPracticeRunConfiguration(CreatePracticeRunConfigurationRequest createPracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  Parameters:
  
  createPracticeRunConfigurationRequest -
  
  Returns:
  
  Result of the CreatePracticeRunConfiguration operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createPracticeRunConfiguration
  
  default CreatePracticeRunConfigurationResponse createPracticeRunConfiguration(Consumer<CreatePracticeRunConfigurationRequest.Builder> createPracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  
  This is a convenience which creates an instance of the CreatePracticeRunConfigurationRequest.Builder avoiding the need to create one manually via CreatePracticeRunConfigurationRequest.builder()
  Parameters:
  
  createPracticeRunConfigurationRequest - A Consumer that will call methods on CreatePracticeRunConfigurationRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreatePracticeRunConfiguration operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deletePracticeRunConfiguration
  
  default DeletePracticeRunConfigurationResponse deletePracticeRunConfiguration(DeletePracticeRunConfigurationRequest deletePracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  Parameters:
  
  deletePracticeRunConfigurationRequest -
  
  Returns:
  
  Result of the DeletePracticeRunConfiguration operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deletePracticeRunConfiguration
  
  default DeletePracticeRunConfigurationResponse deletePracticeRunConfiguration(Consumer<DeletePracticeRunConfigurationRequest.Builder> deletePracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  
  This is a convenience which creates an instance of the DeletePracticeRunConfigurationRequest.Builder avoiding the need to create one manually via DeletePracticeRunConfigurationRequest.builder()
  Parameters:
  
  deletePracticeRunConfigurationRequest - A Consumer that will call methods on DeletePracticeRunConfigurationRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeletePracticeRunConfiguration operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getManagedResource
  
  default GetManagedResourceResponse getManagedResource(GetManagedResourceRequest getManagedResourceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  Parameters:
  
  getManagedResourceRequest -
  
  Returns:
  
  Result of the GetManagedResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getManagedResource
  
  default GetManagedResourceResponse getManagedResource(Consumer<GetManagedResourceRequest.Builder> getManagedResourceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  
  This is a convenience which creates an instance of the GetManagedResourceRequest.Builder avoiding the need to create one manually via GetManagedResourceRequest.builder()
  Parameters:
  
  getManagedResourceRequest - A Consumer that will call methods on GetManagedResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the GetManagedResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAutoshifts
  
  default ListAutoshiftsResponse listAutoshifts(ListAutoshiftsRequest listAutoshiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  Returns the active autoshifts for a specified resource.
  Parameters:
  
  listAutoshiftsRequest -
  
  Returns:
  
  Result of the ListAutoshifts operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAutoshifts
  
  default ListAutoshiftsResponse listAutoshifts(Consumer<ListAutoshiftsRequest.Builder> listAutoshiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  Returns the active autoshifts for a specified resource.
  
  This is a convenience which creates an instance of the ListAutoshiftsRequest.Builder avoiding the need to create one manually via ListAutoshiftsRequest.builder()
  Parameters:
  
  listAutoshiftsRequest - A Consumer that will call methods on ListAutoshiftsRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListAutoshifts operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAutoshiftsPaginator
  
  default ListAutoshiftsIterable listAutoshiftsPaginator(ListAutoshiftsRequest listAutoshiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  This is a variant of listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client.listAutoshiftsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client .listAutoshiftsPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client.listAutoshiftsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest) operation.
  Parameters:
  
  listAutoshiftsRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listAutoshiftsPaginator
  
  default ListAutoshiftsIterable listAutoshiftsPaginator(Consumer<ListAutoshiftsRequest.Builder> listAutoshiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  This is a variant of listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client.listAutoshiftsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client .listAutoshiftsPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client.listAutoshiftsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest) operation.
  
  This is a convenience which creates an instance of the ListAutoshiftsRequest.Builder avoiding the need to create one manually via ListAutoshiftsRequest.builder()
  Parameters:
  
  listAutoshiftsRequest - A Consumer that will call methods on ListAutoshiftsRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listManagedResources
  
  default ListManagedResourcesResponse listManagedResources(ListManagedResourcesRequest listManagedResourcesRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  Parameters:
  
  listManagedResourcesRequest -
  
  Returns:
  
  Result of the ListManagedResources operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listManagedResources
  
  default ListManagedResourcesResponse listManagedResources(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  
  This is a convenience which creates an instance of the ListManagedResourcesRequest.Builder avoiding the need to create one manually via ListManagedResourcesRequest.builder()
  Parameters:
  
  listManagedResourcesRequest - A Consumer that will call methods on ListManagedResourcesRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListManagedResources operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listManagedResourcesPaginator
  
  default ListManagedResourcesIterable listManagedResourcesPaginator(ListManagedResourcesRequest listManagedResourcesRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  This is a variant of listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client.listManagedResourcesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client .listManagedResourcesPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client.listManagedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest) operation.
  Parameters:
  
  listManagedResourcesRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listManagedResourcesPaginator
  
  default ListManagedResourcesIterable listManagedResourcesPaginator(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  This is a variant of listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client.listManagedResourcesPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client .listManagedResourcesPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client.listManagedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest) operation.
  
  This is a convenience which creates an instance of the ListManagedResourcesRequest.Builder avoiding the need to create one manually via ListManagedResourcesRequest.builder()
  Parameters:
  
  listManagedResourcesRequest - A Consumer that will call methods on ListManagedResourcesRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listZonalShifts
  
  default ListZonalShiftsResponse listZonalShifts(ListZonalShiftsRequest listZonalShiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  Parameters:
  
  listZonalShiftsRequest -
  
  Returns:
  
  Result of the ListZonalShifts operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listZonalShifts
  
  default ListZonalShiftsResponse listZonalShifts(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  
  This is a convenience which creates an instance of the ListZonalShiftsRequest.Builder avoiding the need to create one manually via ListZonalShiftsRequest.builder()
  Parameters:
  
  listZonalShiftsRequest - A Consumer that will call methods on ListZonalShiftsRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListZonalShifts operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listZonalShiftsPaginator
  
  default ListZonalShiftsIterable listZonalShiftsPaginator(ListZonalShiftsRequest listZonalShiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  This is a variant of listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client.listZonalShiftsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client .listZonalShiftsPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client.listZonalShiftsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) operation.
  Parameters:
  
  listZonalShiftsRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listZonalShiftsPaginator
  
  default ListZonalShiftsIterable listZonalShiftsPaginator(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  This is a variant of listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client.listZonalShiftsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client .listZonalShiftsPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client.listZonalShiftsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) operation.
  
  This is a convenience which creates an instance of the ListZonalShiftsRequest.Builder avoiding the need to create one manually via ListZonalShiftsRequest.builder()
  Parameters:
  
  listZonalShiftsRequest - A Consumer that will call methods on ListZonalShiftsRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- startZonalShift
  
  default StartZonalShiftResponse startZonalShift(StartZonalShiftRequest startZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  Parameters:
  
  startZonalShiftRequest -
  
  Returns:
  
  Result of the StartZonalShift operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- startZonalShift
  
  default StartZonalShiftResponse startZonalShift(Consumer<StartZonalShiftRequest.Builder> startZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  
  This is a convenience which creates an instance of the StartZonalShiftRequest.Builder avoiding the need to create one manually via StartZonalShiftRequest.builder()
  Parameters:
  
  startZonalShiftRequest - A Consumer that will call methods on StartZonalShiftRequest.Builder to create a request.
  
  Returns:
  
  Result of the StartZonalShift operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updatePracticeRunConfiguration
  
  default UpdatePracticeRunConfigurationResponse updatePracticeRunConfiguration(UpdatePracticeRunConfigurationRequest updatePracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  Parameters:
  
  updatePracticeRunConfigurationRequest -
  
  Returns:
  
  Result of the UpdatePracticeRunConfiguration operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updatePracticeRunConfiguration
  
  default UpdatePracticeRunConfigurationResponse updatePracticeRunConfiguration(Consumer<UpdatePracticeRunConfigurationRequest.Builder> updatePracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  
  This is a convenience which creates an instance of the UpdatePracticeRunConfigurationRequest.Builder avoiding the need to create one manually via UpdatePracticeRunConfigurationRequest.builder()
  Parameters:
  
  updatePracticeRunConfigurationRequest - A Consumer that will call methods on UpdatePracticeRunConfigurationRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdatePracticeRunConfiguration operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateZonalAutoshiftConfiguration
  
  default UpdateZonalAutoshiftConfigurationResponse updateZonalAutoshiftConfiguration(UpdateZonalAutoshiftConfigurationRequest updateZonalAutoshiftConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  Parameters:
  
  updateZonalAutoshiftConfigurationRequest -
  
  Returns:
  
  Result of the UpdateZonalAutoshiftConfiguration operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateZonalAutoshiftConfiguration
  
  default UpdateZonalAutoshiftConfigurationResponse updateZonalAutoshiftConfiguration(Consumer<UpdateZonalAutoshiftConfigurationRequest.Builder> updateZonalAutoshiftConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  
  This is a convenience which creates an instance of the UpdateZonalAutoshiftConfigurationRequest.Builder avoiding the need to create one manually via UpdateZonalAutoshiftConfigurationRequest.builder()
  Parameters:
  
  updateZonalAutoshiftConfigurationRequest - A Consumer that will call methods on UpdateZonalAutoshiftConfigurationRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateZonalAutoshiftConfiguration operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateZonalShift
  
  default UpdateZonalShiftResponse updateZonalShift(UpdateZonalShiftRequest updateZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  Parameters:
  
  updateZonalShiftRequest -
  
  Returns:
  
  Result of the UpdateZonalShift operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateZonalShift
  
  default UpdateZonalShiftResponse updateZonalShift(Consumer<UpdateZonalShiftRequest.Builder> updateZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
  
  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.
  
  This is a convenience which creates an instance of the UpdateZonalShiftRequest.Builder avoiding the need to create one manually via UpdateZonalShiftRequest.builder()
  Parameters:
  
  updateZonalShiftRequest - A Consumer that will call methods on UpdateZonalShiftRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateZonalShift operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- create
  
  static ArcZonalShiftClient create()
  
  Create a ArcZonalShiftClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
- builder
  
  static ArcZonalShiftClientBuilder builder()
  
  Create a builder that can be used to configure and create a ArcZonalShiftClient.
- serviceMetadata
  
  static ServiceMetadata serviceMetadata()
- serviceClientConfiguration
  
  default ArcZonalShiftServiceClientConfiguration serviceClientConfiguration()
  
  Description copied from interface: SdkClient
  
  The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
  
  Specified by:
  
  serviceClientConfiguration in interface AwsClient
  
  Specified by:
  
  serviceClientConfiguration in interface SdkClient
  
  Returns:
  
  SdkServiceClientConfiguration

Interface ArcZonalShiftClient

Field Summary

Method Summary

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

Methods inherited from interface software.amazon.awssdk.core.SdkClient

Field Details

SERVICE_NAME

SERVICE_METADATA_ID

Method Details

cancelZonalShift

cancelZonalShift

createPracticeRunConfiguration

createPracticeRunConfiguration

deletePracticeRunConfiguration

deletePracticeRunConfiguration

getManagedResource

getManagedResource

listAutoshifts

listAutoshifts

listAutoshiftsPaginator

listAutoshiftsPaginator

listManagedResources

listManagedResources

listManagedResourcesPaginator

listManagedResourcesPaginator

listZonalShifts

listZonalShifts

listZonalShiftsPaginator

listZonalShiftsPaginator

startZonalShift

startZonalShift

updatePracticeRunConfiguration

updatePracticeRunConfiguration

updateZonalAutoshiftConfiguration

updateZonalAutoshiftConfiguration

updateZonalShift

updateZonalShift

create

builder

serviceMetadata

serviceClientConfiguration