| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Route53RecoveryCluster
Description
Derived from API version 2019-12-02 of the AWS service descriptions, licensed under Apache 2.0.
Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.
With Route 53 ARC, you can use routing control with extreme reliability to recover applications by rerouting traffic across Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you can run API calls to get or update the state of routing controls. To implement failover, you set one routing control On and another one Off, to reroute traffic from one Availability Zone or Amazon Web Services Region to another.
/Be aware that you must specify a Regional endpoint for a cluster when
you work with API cluster operations to get or update routing control
states in Route 53 ARC./ In addition, you must specify the US West
(Oregon) Region for Route 53 ARC API calls. For example, use the
parameter --region us-west-2 with AWS CLI commands. For more
information, see
Get and update routing control states using the API
in the Amazon Route 53 Application Recovery Controller Developer Guide.
This API guide includes information about the API operations for how to get and update routing control states in Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control panels, and routing controls) using the recovery cluster configuration API.
For more information about working with routing control in Route 53 ARC, see the following:
- Create clusters, control panels, and routing controls by using API operations. For more information, see the Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller.
- Learn about the components in recovery control, including clusters, routing controls, and control panels, and how to work with Route 53 ARC in the Amazon Web Services console. For more information, see Recovery control components in the Amazon Route 53 Application Recovery Controller Developer Guide.
- Route 53 ARC also provides readiness checks that continually audit resources to help make sure that your applications are scaled and ready to handle failover traffic. For more information about the related API operations, see the Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller.
- For more information about creating resilient applications and preparing for recovery readiness with Route 53 ARC, see the Amazon Route 53 Application Recovery Controller Developer Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _EndpointTemporarilyUnavailableException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceLimitExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data GetRoutingControlState = GetRoutingControlState' Text
- newGetRoutingControlState :: Text -> GetRoutingControlState
- data GetRoutingControlStateResponse = GetRoutingControlStateResponse' (Maybe Text) Int Text RoutingControlState
- newGetRoutingControlStateResponse :: Int -> Text -> RoutingControlState -> GetRoutingControlStateResponse
- data ListRoutingControls = ListRoutingControls' (Maybe Text) (Maybe Natural) (Maybe Text)
- newListRoutingControls :: ListRoutingControls
- data ListRoutingControlsResponse = ListRoutingControlsResponse' (Maybe Text) Int [RoutingControl]
- newListRoutingControlsResponse :: Int -> ListRoutingControlsResponse
- data UpdateRoutingControlState = UpdateRoutingControlState' (Maybe [Text]) Text RoutingControlState
- newUpdateRoutingControlState :: Text -> RoutingControlState -> UpdateRoutingControlState
- data UpdateRoutingControlStateResponse = UpdateRoutingControlStateResponse' Int
- newUpdateRoutingControlStateResponse :: Int -> UpdateRoutingControlStateResponse
- data UpdateRoutingControlStates = UpdateRoutingControlStates' (Maybe [Text]) [UpdateRoutingControlStateEntry]
- newUpdateRoutingControlStates :: UpdateRoutingControlStates
- data UpdateRoutingControlStatesResponse = UpdateRoutingControlStatesResponse' Int
- newUpdateRoutingControlStatesResponse :: Int -> UpdateRoutingControlStatesResponse
- newtype RoutingControlState where
- RoutingControlState' { }
- pattern RoutingControlState_Off :: RoutingControlState
- pattern RoutingControlState_On :: RoutingControlState
- data RoutingControl = RoutingControl' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RoutingControlState)
- newRoutingControl :: RoutingControl
- data UpdateRoutingControlStateEntry = UpdateRoutingControlStateEntry' Text RoutingControlState
- newUpdateRoutingControlStateEntry :: Text -> RoutingControlState -> UpdateRoutingControlStateEntry
Service Configuration
defaultService :: Service Source #
API version 2019-12-02 of the Amazon Route53 Recovery Cluster SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Route53RecoveryCluster.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient permissions to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
There was a conflict with this request. Try again.
EndpointTemporarilyUnavailableException
_EndpointTemporarilyUnavailableException :: AsError a => Fold a ServiceError Source #
The cluster endpoint isn't available. Try another cluster endpoint.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
There was an unexpected error during processing of the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The request references a routing control or control panel that was not found.
ServiceLimitExceededException
_ServiceLimitExceededException :: AsError a => Fold a ServiceError Source #
The request can't update that many routing control states at the same time. Try again with fewer routing control states.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied because of request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
There was a validation error on the request.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetRoutingControlState
data GetRoutingControlState Source #
See: newGetRoutingControlState smart constructor.
Constructors
| GetRoutingControlState' Text |
Instances
newGetRoutingControlState Source #
Arguments
| :: Text | |
| -> GetRoutingControlState |
Create a value of GetRoutingControlState with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetRoutingControlState, getRoutingControlState_routingControlArn - The Amazon Resource Name (ARN) for the routing control that you want to
get the state for.
data GetRoutingControlStateResponse Source #
See: newGetRoutingControlStateResponse smart constructor.
Constructors
| GetRoutingControlStateResponse' (Maybe Text) Int Text RoutingControlState |
Instances
newGetRoutingControlStateResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> RoutingControlState | |
| -> GetRoutingControlStateResponse |
Create a value of GetRoutingControlStateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetRoutingControlStateResponse, getRoutingControlStateResponse_routingControlName - The routing control name.
$sel:httpStatus:GetRoutingControlStateResponse', getRoutingControlStateResponse_httpStatus - The response's http status code.
GetRoutingControlState, getRoutingControlStateResponse_routingControlArn - The Amazon Resource Name (ARN) of the response.
GetRoutingControlStateResponse, getRoutingControlStateResponse_routingControlState - The state of the routing control.
ListRoutingControls (Paginated)
data ListRoutingControls Source #
See: newListRoutingControls smart constructor.
Instances
newListRoutingControls :: ListRoutingControls Source #
Create a value of ListRoutingControls with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRoutingControls, listRoutingControls_controlPanelArn - The Amazon Resource Name (ARN) of the control panel of the routing
controls to list.
$sel:maxResults:ListRoutingControls', listRoutingControls_maxResults - The number of routing controls objects that you want to return with this
call. The default value is 500.
ListRoutingControls, listRoutingControls_nextToken - The token for the next set of results. You receive this token from a
previous call.
data ListRoutingControlsResponse Source #
See: newListRoutingControlsResponse smart constructor.
Constructors
| ListRoutingControlsResponse' (Maybe Text) Int [RoutingControl] |
Instances
newListRoutingControlsResponse Source #
Create a value of ListRoutingControlsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRoutingControls, listRoutingControlsResponse_nextToken - The token for the next set of results. You receive this token from a
previous call.
$sel:httpStatus:ListRoutingControlsResponse', listRoutingControlsResponse_httpStatus - The response's http status code.
$sel:routingControls:ListRoutingControlsResponse', listRoutingControlsResponse_routingControls - The list of routing controls.
UpdateRoutingControlState
data UpdateRoutingControlState Source #
See: newUpdateRoutingControlState smart constructor.
Constructors
| UpdateRoutingControlState' (Maybe [Text]) Text RoutingControlState |
Instances
newUpdateRoutingControlState Source #
Arguments
| :: Text | |
| -> RoutingControlState | |
| -> UpdateRoutingControlState |
Create a value of UpdateRoutingControlState with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:safetyRulesToOverride:UpdateRoutingControlState', updateRoutingControlState_safetyRulesToOverride - The Amazon Resource Names (ARNs) for the safety rules that you want to
override when you're updating the state of a routing control. You can
override one safety rule or multiple safety rules by including one or
more ARNs, separated by commas.
For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
UpdateRoutingControlState, updateRoutingControlState_routingControlArn - The Amazon Resource Name (ARN) for the routing control that you want to
update the state for.
UpdateRoutingControlState, updateRoutingControlState_routingControlState - The state of the routing control. You can set the value to be On or Off.
data UpdateRoutingControlStateResponse Source #
See: newUpdateRoutingControlStateResponse smart constructor.
Constructors
| UpdateRoutingControlStateResponse' Int |
Instances
newUpdateRoutingControlStateResponse Source #
Arguments
| :: Int | |
| -> UpdateRoutingControlStateResponse |
Create a value of UpdateRoutingControlStateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateRoutingControlStateResponse', updateRoutingControlStateResponse_httpStatus - The response's http status code.
UpdateRoutingControlStates
data UpdateRoutingControlStates Source #
See: newUpdateRoutingControlStates smart constructor.
Constructors
| UpdateRoutingControlStates' (Maybe [Text]) [UpdateRoutingControlStateEntry] |
Instances
newUpdateRoutingControlStates :: UpdateRoutingControlStates Source #
Create a value of UpdateRoutingControlStates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:safetyRulesToOverride:UpdateRoutingControlStates', updateRoutingControlStates_safetyRulesToOverride - The Amazon Resource Names (ARNs) for the safety rules that you want to
override when you're updating routing control states. You can override
one safety rule or multiple safety rules by including one or more ARNs,
separated by commas.
For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
$sel:updateRoutingControlStateEntries:UpdateRoutingControlStates', updateRoutingControlStates_updateRoutingControlStateEntries - A set of routing control entries that you want to update.
data UpdateRoutingControlStatesResponse Source #
See: newUpdateRoutingControlStatesResponse smart constructor.
Constructors
| UpdateRoutingControlStatesResponse' Int |
Instances
newUpdateRoutingControlStatesResponse Source #
Arguments
| :: Int | |
| -> UpdateRoutingControlStatesResponse |
Create a value of UpdateRoutingControlStatesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateRoutingControlStatesResponse', updateRoutingControlStatesResponse_httpStatus - The response's http status code.
Types
RoutingControlState
newtype RoutingControlState Source #
Constructors
| RoutingControlState' | |
Fields | |
Bundled Patterns
| pattern RoutingControlState_Off :: RoutingControlState | |
| pattern RoutingControlState_On :: RoutingControlState |
Instances
RoutingControl
data RoutingControl Source #
A routing control, which is a simple on/off switch that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.
See: newRoutingControl smart constructor.
Constructors
| RoutingControl' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RoutingControlState) |
Instances
newRoutingControl :: RoutingControl Source #
Create a value of RoutingControl with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:controlPanelArn:RoutingControl', routingControl_controlPanelArn - The Amazon Resource Name (ARN) of the control panel where the routing
control is located.
$sel:controlPanelName:RoutingControl', routingControl_controlPanelName - The name of the control panel where the routing control is located.
$sel:routingControlArn:RoutingControl', routingControl_routingControlArn - The Amazon Resource Name (ARN) of the routing control.
$sel:routingControlName:RoutingControl', routingControl_routingControlName - The name of the routing control.
$sel:routingControlState:RoutingControl', routingControl_routingControlState - The current state of the routing control. When a routing control state
is On, traffic flows to a cell. When the state is Off, traffic does not
flow.
UpdateRoutingControlStateEntry
data UpdateRoutingControlStateEntry Source #
A routing control state entry.
See: newUpdateRoutingControlStateEntry smart constructor.
Constructors
| UpdateRoutingControlStateEntry' Text RoutingControlState |
Instances
newUpdateRoutingControlStateEntry Source #
Arguments
| :: Text | |
| -> RoutingControlState | |
| -> UpdateRoutingControlStateEntry |
Create a value of UpdateRoutingControlStateEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:routingControlArn:UpdateRoutingControlStateEntry', updateRoutingControlStateEntry_routingControlArn - The Amazon Resource Name (ARN) for a routing control state entry.
$sel:routingControlState:UpdateRoutingControlStateEntry', updateRoutingControlStateEntry_routingControlState - The routing control state in a set of routing control state entries.