@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ArcZonalShiftAsyncClient extends AwsClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static ArcZonalShiftAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
ArcZonalShiftAsyncClient. |
default CompletableFuture<CancelZonalShiftResponse> |
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.
|
default CompletableFuture<CancelZonalShiftResponse> |
cancelZonalShift(Consumer<CancelZonalShiftRequest.Builder> 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.
|
static ArcZonalShiftAsyncClient |
create()
Create a
ArcZonalShiftAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<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 AWS Region.
|
default CompletableFuture<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 AWS Region.
|
default CompletableFuture<ListManagedResourcesResponse> |
listManagedResources(Consumer<ListManagedResourcesRequest.Builder> 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.
|
default CompletableFuture<ListManagedResourcesResponse> |
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.
|
default ListManagedResourcesPublisher |
listManagedResourcesPaginator(Consumer<ListManagedResourcesRequest.Builder> 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.
|
default ListManagedResourcesPublisher |
listManagedResourcesPaginator(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.
|
default CompletableFuture<ListZonalShiftsResponse> |
listZonalShifts(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest)
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this
AWS Region.
|
default CompletableFuture<ListZonalShiftsResponse> |
listZonalShifts(ListZonalShiftsRequest listZonalShiftsRequest)
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this
AWS Region.
|
default ListZonalShiftsPublisher |
listZonalShiftsPaginator(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest)
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this
AWS Region.
|
default ListZonalShiftsPublisher |
listZonalShiftsPaginator(ListZonalShiftsRequest listZonalShiftsRequest)
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this
AWS Region.
|
default ArcZonalShiftServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartZonalShiftResponse> |
startZonalShift(Consumer<StartZonalShiftRequest.Builder> 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.
|
default CompletableFuture<StartZonalShiftResponse> |
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.
|
default CompletableFuture<UpdateZonalShiftResponse> |
updateZonalShift(Consumer<UpdateZonalShiftRequest.Builder> updateZonalShiftRequest)
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account.
|
default CompletableFuture<UpdateZonalShiftResponse> |
updateZonalShift(UpdateZonalShiftRequest updateZonalShiftRequest)
Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CancelZonalShiftResponse> 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.
cancelZonalShiftRequest - default CompletableFuture<CancelZonalShiftResponse> cancelZonalShift(Consumer<CancelZonalShiftRequest.Builder> 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.
This is a convenience which creates an instance of the CancelZonalShiftRequest.Builder avoiding the need
to create one manually via CancelZonalShiftRequest.builder()
cancelZonalShiftRequest - A Consumer that will call methods on CancelZonalShiftRequest.Builder to create a request.default CompletableFuture<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 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.
getManagedResourceRequest - default CompletableFuture<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 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.
This is a convenience which creates an instance of the GetManagedResourceRequest.Builder avoiding the
need to create one manually via GetManagedResourceRequest.builder()
getManagedResourceRequest - A Consumer that will call methods on GetManagedResourceRequest.Builder to create a
request.default CompletableFuture<ListManagedResourcesResponse> 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.
listManagedResourcesRequest - default CompletableFuture<ListManagedResourcesResponse> listManagedResources(Consumer<ListManagedResourcesRequest.Builder> 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.
This is a convenience which creates an instance of the ListManagedResourcesRequest.Builder avoiding the
need to create one manually via ListManagedResourcesRequest.builder()
listManagedResourcesRequest - A Consumer that will call methods on ListManagedResourcesRequest.Builder to create a
request.default ListManagedResourcesPublisher listManagedResourcesPaginator(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.
This is a variant of
listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesPublisher publisher = client.listManagedResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesPublisher publisher = client.listManagedResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listManagedResourcesRequest - default ListManagedResourcesPublisher listManagedResourcesPaginator(Consumer<ListManagedResourcesRequest.Builder> 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.
This is a variant of
listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesPublisher publisher = client.listManagedResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesPublisher publisher = client.listManagedResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listManagedResourcesRequest - A Consumer that will call methods on ListManagedResourcesRequest.Builder to create a
request.default CompletableFuture<ListZonalShiftsResponse> listZonalShifts(ListZonalShiftsRequest listZonalShiftsRequest)
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
listZonalShiftsRequest - default CompletableFuture<ListZonalShiftsResponse> listZonalShifts(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest)
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
This is a convenience which creates an instance of the ListZonalShiftsRequest.Builder avoiding the need
to create one manually via ListZonalShiftsRequest.builder()
listZonalShiftsRequest - A Consumer that will call methods on ListZonalShiftsRequest.Builder to create a request.default ListZonalShiftsPublisher listZonalShiftsPaginator(ListZonalShiftsRequest listZonalShiftsRequest)
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
This is a variant of
listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsPublisher publisher = client.listZonalShiftsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsPublisher publisher = client.listZonalShiftsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listZonalShiftsRequest - default ListZonalShiftsPublisher listZonalShiftsPaginator(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest)
Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
This is a variant of
listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsPublisher publisher = client.listZonalShiftsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsPublisher publisher = client.listZonalShiftsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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()
listZonalShiftsRequest - A Consumer that will call methods on ListZonalShiftsRequest.Builder to create a request.default CompletableFuture<StartZonalShiftResponse> 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.
startZonalShiftRequest - default CompletableFuture<StartZonalShiftResponse> startZonalShift(Consumer<StartZonalShiftRequest.Builder> 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.
This is a convenience which creates an instance of the StartZonalShiftRequest.Builder avoiding the need
to create one manually via StartZonalShiftRequest.builder()
startZonalShiftRequest - A Consumer that will call methods on StartZonalShiftRequest.Builder to create a request.default CompletableFuture<UpdateZonalShiftResponse> 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.
updateZonalShiftRequest - default CompletableFuture<UpdateZonalShiftResponse> updateZonalShift(Consumer<UpdateZonalShiftRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateZonalShiftRequest.Builder avoiding the need
to create one manually via UpdateZonalShiftRequest.builder()
updateZonalShiftRequest - A Consumer that will call methods on UpdateZonalShiftRequest.Builder to create a request.default ArcZonalShiftServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic ArcZonalShiftAsyncClient create()
ArcZonalShiftAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ArcZonalShiftAsyncClientBuilder builder()
ArcZonalShiftAsyncClient.Copyright © 2023. All rights reserved.