| 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.ListRoutingControls
Description
List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster.
A routing control is a simple on/off switch in Route 53 ARC 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 use this API operation to list routing controls in Route 53 ARC./
Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:
This operation returns paginated results.
Synopsis
- data ListRoutingControls = ListRoutingControls' {}
- newListRoutingControls :: ListRoutingControls
- listRoutingControls_controlPanelArn :: Lens' ListRoutingControls (Maybe Text)
- listRoutingControls_maxResults :: Lens' ListRoutingControls (Maybe Natural)
- listRoutingControls_nextToken :: Lens' ListRoutingControls (Maybe Text)
- data ListRoutingControlsResponse = ListRoutingControlsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- routingControls :: [RoutingControl]
- newListRoutingControlsResponse :: Int -> ListRoutingControlsResponse
- listRoutingControlsResponse_nextToken :: Lens' ListRoutingControlsResponse (Maybe Text)
- listRoutingControlsResponse_httpStatus :: Lens' ListRoutingControlsResponse Int
- listRoutingControlsResponse_routingControls :: Lens' ListRoutingControlsResponse [RoutingControl]
Creating a Request
data ListRoutingControls Source #
See: newListRoutingControls smart constructor.
Constructors
| ListRoutingControls' | |
Fields
| |
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.
Request Lenses
listRoutingControls_controlPanelArn :: Lens' ListRoutingControls (Maybe Text) Source #
The Amazon Resource Name (ARN) of the control panel of the routing controls to list.
listRoutingControls_maxResults :: Lens' ListRoutingControls (Maybe Natural) Source #
The number of routing controls objects that you want to return with this call. The default value is 500.
listRoutingControls_nextToken :: Lens' ListRoutingControls (Maybe Text) Source #
The token for the next set of results. You receive this token from a previous call.
Destructuring the Response
data ListRoutingControlsResponse Source #
See: newListRoutingControlsResponse smart constructor.
Constructors
| ListRoutingControlsResponse' | |
Fields
| |
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.
Response Lenses
listRoutingControlsResponse_nextToken :: Lens' ListRoutingControlsResponse (Maybe Text) Source #
The token for the next set of results. You receive this token from a previous call.
listRoutingControlsResponse_httpStatus :: Lens' ListRoutingControlsResponse Int Source #
The response's http status code.
listRoutingControlsResponse_routingControls :: Lens' ListRoutingControlsResponse [RoutingControl] Source #
The list of routing controls.