| 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.GetRoutingControlState
Description
Get the state for a routing control. A routing control 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.
Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application.
/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.
Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:
Synopsis
- data GetRoutingControlState = GetRoutingControlState' {}
- newGetRoutingControlState :: Text -> GetRoutingControlState
- getRoutingControlState_routingControlArn :: Lens' GetRoutingControlState Text
- data GetRoutingControlStateResponse = GetRoutingControlStateResponse' {}
- newGetRoutingControlStateResponse :: Int -> Text -> RoutingControlState -> GetRoutingControlStateResponse
- getRoutingControlStateResponse_routingControlName :: Lens' GetRoutingControlStateResponse (Maybe Text)
- getRoutingControlStateResponse_httpStatus :: Lens' GetRoutingControlStateResponse Int
- getRoutingControlStateResponse_routingControlArn :: Lens' GetRoutingControlStateResponse Text
- getRoutingControlStateResponse_routingControlState :: Lens' GetRoutingControlStateResponse RoutingControlState
Creating a Request
data GetRoutingControlState Source #
See: newGetRoutingControlState smart constructor.
Constructors
| GetRoutingControlState' | |
Fields
| |
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.
Request Lenses
getRoutingControlState_routingControlArn :: Lens' GetRoutingControlState Text Source #
The Amazon Resource Name (ARN) for the routing control that you want to get the state for.
Destructuring the Response
data GetRoutingControlStateResponse Source #
See: newGetRoutingControlStateResponse smart constructor.
Constructors
| GetRoutingControlStateResponse' | |
Fields
| |
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.
Response Lenses
getRoutingControlStateResponse_routingControlName :: Lens' GetRoutingControlStateResponse (Maybe Text) Source #
The routing control name.
getRoutingControlStateResponse_httpStatus :: Lens' GetRoutingControlStateResponse Int Source #
The response's http status code.
getRoutingControlStateResponse_routingControlArn :: Lens' GetRoutingControlStateResponse Text Source #
The Amazon Resource Name (ARN) of the response.
getRoutingControlStateResponse_routingControlState :: Lens' GetRoutingControlStateResponse RoutingControlState Source #
The state of the routing control.