Route53 Recovery Cluster 2019-12-02
- Client: Aws\Route53RecoveryCluster\Route53RecoveryClusterClient
- Service ID: route53-recovery-cluster
- Version: 2019-12-02
This page describes the parameters and results for the operations of the Route53 Recovery Cluster (2019-12-02), and shows how to use the Aws\Route53RecoveryCluster\Route53RecoveryClusterClient object to call the described operations. This documentation is specific to the 2019-12-02 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- GetRoutingControlState ( array $params = [] )
Get the state for a routing control.
- UpdateRoutingControlState ( array $params = [] )
Set the state of the routing control to reroute traffic.
- UpdateRoutingControlStates ( array $params = [] )
Set multiple routing control states.
Operations
GetRoutingControlState
$result = $client->getRoutingControlState([/* ... */]); $promise = $client->getRoutingControlStateAsync([/* ... */]);
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 the state is On, traffic flows to a cell. When it's off, traffic does not flow.
Before you can create a routing control, you first must create a cluster to host the control. For more information, see CreateCluster. Access one of the endpoints for the cluster to get or update the routing control state to redirect traffic.
For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.
Parameter Syntax
$result = $client->getRoutingControlState([
'RoutingControlArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'RoutingControlArn' => '<string>',
'RoutingControlState' => 'On|Off',
]
Result Details
Members
Errors
-
You don't have sufficient permissions to query the routing control state.
-
There was an unexpected error during processing of the request.
-
The request references a routing control that was not found.
-
There was a validation error on the request.
-
The request was denied because of request throttling.
-
EndpointTemporarilyUnavailableException:
The cluster endpoint isn't available. Try another cluster endpoint.
UpdateRoutingControlState
$result = $client->updateRoutingControlState([/* ... */]); $promise = $client->updateRoutingControlStateAsync([/* ... */]);
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 it's off, traffic does not flow.
For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.
Parameter Syntax
$result = $client->updateRoutingControlState([
'RoutingControlArn' => '<string>', // REQUIRED
'RoutingControlState' => 'On|Off', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
You don't have sufficient permissions to query the routing control state.
-
There was an unexpected error during processing of the request.
-
The request references a routing control that was not found.
-
There was a validation error on the request.
-
The request was denied because of request throttling.
-
EndpointTemporarilyUnavailableException:
The cluster endpoint isn't available. Try another cluster endpoint.
-
There was a conflict with this request. Try again.
UpdateRoutingControlStates
$result = $client->updateRoutingControlStates([/* ... */]); $promise = $client->updateRoutingControlStatesAsync([/* ... */]);
Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.
For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.
Parameter Syntax
$result = $client->updateRoutingControlStates([
'UpdateRoutingControlStateEntries' => [ // REQUIRED
[
'RoutingControlArn' => '<string>', // REQUIRED
'RoutingControlState' => 'On|Off', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- UpdateRoutingControlStateEntries
-
- Required: Yes
- Type: Array of UpdateRoutingControlStateEntry structures
A set of routing control entries that you want to update.
Result Syntax
[]
Result Details
Errors
-
You don't have sufficient permissions to query the routing control state.
-
There was an unexpected error during processing of the request.
-
The request references a routing control that was not found.
-
There was a validation error on the request.
-
The request was denied because of request throttling.
-
EndpointTemporarilyUnavailableException:
The cluster endpoint isn't available. Try another cluster endpoint.
-
There was a conflict with this request. Try again.
Shapes
AccessDeniedException
Description
You don't have sufficient permissions to query the routing control state.
Members
ConflictException
Description
There was a conflict with this request. Try again.
Members
EndpointTemporarilyUnavailableException
Description
The cluster endpoint isn't available. Try another cluster endpoint.
Members
InternalServerException
Description
There was an unexpected error during processing of the request.
Members
ResourceNotFoundException
Description
The request references a routing control that was not found.
Members
ThrottlingException
Description
The request was denied because of request throttling.
Members
UpdateRoutingControlStateEntry
Description
A routing control state.
Members
ValidationException
Description
There was a validation error on the request.
Members
- fields
-
- Type: Array of ValidationExceptionField structures
The fields that caused the error, if applicable - message
-
- Required: Yes
- Type: string
- reason
-
- Type: string
Reason the request failed validation