AbstractAWSARCZonalShift (AWS Java SDK for AWS ARC

java.lang.Object
- com.amazonaws.services.arczonalshift.AbstractAWSARCZonalShift

All Implemented Interfaces:

AWSARCZonalShift

Direct Known Subclasses:

AbstractAWSARCZonalShiftAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSARCZonalShift
extends Object
implements AWSARCZonalShift
```
Abstract implementation of AWSARCZonalShift. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.arczonalshift.AWSARCZonalShift
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAWSARCZonalShift()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAWSARCZonalShift()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CancelZonalShiftResult`	`cancelZonalShift(CancelZonalShiftRequest request)` Cancel a zonal shift in Amazon Route 53 Application Recovery Controller.
`CreatePracticeRunConfigurationResult`	`createPracticeRunConfiguration(CreatePracticeRunConfigurationRequest request)` A practice run configuration for zonal autoshift is required when you enable zonal autoshift.
`DeletePracticeRunConfigurationResult`	`deletePracticeRunConfiguration(DeletePracticeRunConfigurationRequest request)` Deletes the practice run configuration for a resource.
`GetAutoshiftObserverNotificationStatusResult`	`getAutoshiftObserverNotificationStatus(GetAutoshiftObserverNotificationStatusRequest request)` Returns the status of autoshift observer notification.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetManagedResourceResult`	`getManagedResource(GetManagedResourceRequest request)` Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region.
`ListAutoshiftsResult`	`listAutoshifts(ListAutoshiftsRequest request)` Returns a list of autoshifts for an Amazon Web Services Region.
`ListManagedResourcesResult`	`listManagedResources(ListManagedResourcesRequest request)` Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them.
`ListZonalShiftsResult`	`listZonalShifts(ListZonalShiftsRequest request)` Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartZonalShiftResult`	`startZonalShift(StartZonalShiftRequest request)` You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.
`UpdateAutoshiftObserverNotificationStatusResult`	`updateAutoshiftObserverNotificationStatus(UpdateAutoshiftObserverNotificationStatusRequest request)` Update the status of autoshift observer notification.
`UpdatePracticeRunConfigurationResult`	`updatePracticeRunConfiguration(UpdatePracticeRunConfigurationRequest request)` Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
`UpdateZonalAutoshiftConfigurationResult`	`updateZonalAutoshiftConfiguration(UpdateZonalAutoshiftConfigurationRequest request)` The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status.
`UpdateZonalShiftResult`	`updateZonalShift(UpdateZonalShiftRequest request)` Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAWSARCZonalShift
```
protected AbstractAWSARCZonalShift()
```
- Method Detail
  - cancelZonalShift
```
public CancelZonalShiftResult cancelZonalShift(CancelZonalShiftRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.
    
    A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.
    
    Specified by:
    
    cancelZonalShift in interface AWSARCZonalShift
    
    Returns:
    
    Result of the CancelZonalShift operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPracticeRunConfiguration
```
public CreatePracticeRunConfigurationResult createPracticeRunConfiguration(CreatePracticeRunConfigurationRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.
    
    When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.
    
    For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
    
    Specified by:
    
    createPracticeRunConfiguration in interface AWSARCZonalShift
    
    Returns:
    
    Result of the CreatePracticeRunConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePracticeRunConfiguration
```
public DeletePracticeRunConfigurationResult deletePracticeRunConfiguration(DeletePracticeRunConfigurationRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.
    
    Specified by:
    
    deletePracticeRunConfiguration in interface AWSARCZonalShift
    
    Returns:
    
    Result of the DeletePracticeRunConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAutoshiftObserverNotificationStatus
```
public GetAutoshiftObserverNotificationStatusResult getAutoshiftObserverNotificationStatus(GetAutoshiftObserverNotificationStatusRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    Returns the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.
    
    If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
    
    For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.
    
    Specified by:
    
    getAutoshiftObserverNotificationStatus in interface AWSARCZonalShift
    
    Returns:
    
    Result of the GetAutoshiftObserverNotificationStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getManagedResource
```
public GetManagedResourceResult getManagedResource(GetManagedResourceRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
    
    At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
    
    Specified by:
    
    getManagedResource in interface AWSARCZonalShift
    
    Returns:
    
    Result of the GetManagedResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAutoshifts
```
public ListAutoshiftsResult listAutoshifts(ListAutoshiftsRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.
    
    Specified by:
    
    listAutoshifts in interface AWSARCZonalShift
    
    Returns:
    
    Result of the ListAutoshifts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listManagedResources
```
public ListManagedResourcesResult listManagedResources(ListManagedResourcesRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.
    
    Specified by:
    
    listManagedResources in interface AWSARCZonalShift
    
    Returns:
    
    Result of the ListManagedResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listZonalShifts
```
public ListZonalShiftsResult listZonalShifts(ListZonalShiftsRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.
    
    The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts.
    
    Specified by:
    
    listZonalShifts in interface AWSARCZonalShift
    
    Returns:
    
    Result of the ListZonalShifts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startZonalShift
```
public StartZonalShiftResult startZonalShift(StartZonalShiftRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.
    
    At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
    
    When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.
    
    For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.
    
    Specified by:
    
    startZonalShift in interface AWSARCZonalShift
    
    Returns:
    
    Result of the StartZonalShift operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAutoshiftObserverNotificationStatus
```
public UpdateAutoshiftObserverNotificationStatusResult updateAutoshiftObserverNotificationStatus(UpdateAutoshiftObserverNotificationStatusRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.
    
    If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.
    
    For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.
    
    Specified by:
    
    updateAutoshiftObserverNotificationStatus in interface AWSARCZonalShift
    
    Returns:
    
    Result of the UpdateAutoshiftObserverNotificationStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePracticeRunConfiguration
```
public UpdatePracticeRunConfigurationResult updatePracticeRunConfiguration(UpdatePracticeRunConfigurationRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
    
    Specified by:
    
    updatePracticeRunConfiguration in interface AWSARCZonalShift
    
    Returns:
    
    Result of the UpdatePracticeRunConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateZonalAutoshiftConfiguration
```
public UpdateZonalAutoshiftConfigurationResult updateZonalAutoshiftConfiguration(UpdateZonalAutoshiftConfigurationRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.
    
    You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.
    
    Specified by:
    
    updateZonalAutoshiftConfiguration in interface AWSARCZonalShift
    
    Returns:
    
    Result of the UpdateZonalAutoshiftConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateZonalShift
```
public UpdateZonalShiftResult updateZonalShift(UpdateZonalShiftRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.
    
    Specified by:
    
    updateZonalShift in interface AWSARCZonalShift
    
    Returns:
    
    Result of the UpdateZonalShift operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSARCZonalShift
    
    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.
    
    Specified by:
    
    shutdown in interface AWSARCZonalShift
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSARCZonalShift
    
    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.
    
    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.

Class AbstractAWSARCZonalShift

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAWSARCZonalShift

Method Detail

cancelZonalShift

createPracticeRunConfiguration

deletePracticeRunConfiguration

getAutoshiftObserverNotificationStatus

getManagedResource

listAutoshifts

listManagedResources

listZonalShifts

startZonalShift

updateAutoshiftObserverNotificationStatus

updatePracticeRunConfiguration

updateZonalAutoshiftConfiguration

updateZonalShift

shutdown

getCachedResponseMetadata