| 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.UpdateRoutingControlState
Description
Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When the state is Off, traffic does not flow.
With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.
The SafetyRulesToOverride property enables you override one or more
safety rules and update routing control states. For more information,
see
Override safety rules to reroute traffic
in the Amazon Route 53 Application Recovery Controller Developer Guide.
/You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC./
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide.
Synopsis
- data UpdateRoutingControlState = UpdateRoutingControlState' {}
- newUpdateRoutingControlState :: Text -> RoutingControlState -> UpdateRoutingControlState
- updateRoutingControlState_safetyRulesToOverride :: Lens' UpdateRoutingControlState (Maybe [Text])
- updateRoutingControlState_routingControlArn :: Lens' UpdateRoutingControlState Text
- updateRoutingControlState_routingControlState :: Lens' UpdateRoutingControlState RoutingControlState
- data UpdateRoutingControlStateResponse = UpdateRoutingControlStateResponse' {
- httpStatus :: Int
- newUpdateRoutingControlStateResponse :: Int -> UpdateRoutingControlStateResponse
- updateRoutingControlStateResponse_httpStatus :: Lens' UpdateRoutingControlStateResponse Int
Creating a Request
data UpdateRoutingControlState Source #
See: newUpdateRoutingControlState smart constructor.
Constructors
| UpdateRoutingControlState' | |
Fields
| |
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.
Request Lenses
updateRoutingControlState_safetyRulesToOverride :: Lens' UpdateRoutingControlState (Maybe [Text]) Source #
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_routingControlArn :: Lens' UpdateRoutingControlState Text Source #
The Amazon Resource Name (ARN) for the routing control that you want to update the state for.
updateRoutingControlState_routingControlState :: Lens' UpdateRoutingControlState RoutingControlState Source #
The state of the routing control. You can set the value to be On or Off.
Destructuring the Response
data UpdateRoutingControlStateResponse Source #
See: newUpdateRoutingControlStateResponse smart constructor.
Constructors
| UpdateRoutingControlStateResponse' | |
Fields
| |
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.
Response Lenses
updateRoutingControlStateResponse_httpStatus :: Lens' UpdateRoutingControlStateResponse Int Source #
The response's http status code.