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.
- ListRoutingControls ( array $params = [] )
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.
- UpdateRoutingControlState ( array $params = [] )
Set the state of the routing control to reroute traffic.
- UpdateRoutingControlStates ( array $params = [] )
Set multiple routing control states.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
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 a routing control state is set to ON, traffic flows to a cell. When the state is set to 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:
Parameter Syntax
$result = $client->getRoutingControlState([
'RoutingControlArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- RoutingControlArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the routing control that you want to get the state for.
Result Syntax
[
'RoutingControlArn' => '<string>',
'RoutingControlName' => '<string>',
'RoutingControlState' => 'On|Off',
]
Result Details
Members
- RoutingControlArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the response.
- RoutingControlName
-
- Type: string
The routing control name.
- RoutingControlState
-
- Required: Yes
- Type: string
The state of the routing control.
Errors
-
You don't have sufficient permissions to perform this action.
-
There was an unexpected error during processing of the request.
-
The request references a routing control or control panel 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.
ListRoutingControls
$result = $client->listRoutingControls([/* ... */]); $promise = $client->listRoutingControlsAsync([/* ... */]);
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 set to ON, traffic flows to a cell. When the state is set to 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:
Parameter Syntax
$result = $client->listRoutingControls([
'ControlPanelArn' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- ControlPanelArn
-
- Type: string
The Amazon Resource Name (ARN) of the control panel of the routing controls to list.
- MaxResults
-
- Type: int
The number of routing controls objects that you want to return with this call. The default value is 500.
- NextToken
-
- Type: string
The token for the next set of results. You receive this token from a previous call.
Result Syntax
[
'NextToken' => '<string>',
'RoutingControls' => [
[
'ControlPanelArn' => '<string>',
'ControlPanelName' => '<string>',
'Owner' => '<string>',
'RoutingControlArn' => '<string>',
'RoutingControlName' => '<string>',
'RoutingControlState' => 'On|Off',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token for the next set of results. You receive this token from a previous call.
- RoutingControls
-
- Required: Yes
- Type: Array of RoutingControl structures
The list of routing controls.
Errors
-
You don't have sufficient permissions to perform this action.
-
There was an unexpected error during processing of the request.
-
The request references a routing control or control panel 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 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.
Parameter Syntax
$result = $client->updateRoutingControlState([
'RoutingControlArn' => '<string>', // REQUIRED
'RoutingControlState' => 'On|Off', // REQUIRED
'SafetyRulesToOverride' => ['<string>', ...],
]);
Parameter Details
Members
- RoutingControlArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the routing control that you want to update the state for.
- RoutingControlState
-
- Required: Yes
- Type: string
The state of the routing control. You can set the value to ON or OFF.
- SafetyRulesToOverride
-
- Type: Array of strings
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.
Result Syntax
[]
Result Details
Errors
-
You don't have sufficient permissions to perform this action.
-
There was an unexpected error during processing of the request.
-
The request references a routing control or control panel 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.
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.
Parameter Syntax
$result = $client->updateRoutingControlStates([
'SafetyRulesToOverride' => ['<string>', ...],
'UpdateRoutingControlStateEntries' => [ // REQUIRED
[
'RoutingControlArn' => '<string>', // REQUIRED
'RoutingControlState' => 'On|Off', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- SafetyRulesToOverride
-
- Type: Array of strings
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.
- 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 perform this action.
-
There was an unexpected error during processing of the request.
-
The request references a routing control or control panel 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.
-
ServiceLimitExceededException:
The request can't update that many routing control states at the same time. Try again with fewer routing control states.
Shapes
AccessDeniedException
Description
You don't have sufficient permissions to perform this action.
Members
- message
-
- Required: Yes
- Type: string
ConflictException
Description
There was a conflict with this request. Try again.
Members
- message
-
- Required: Yes
- Type: string
Description of the ConflictException error - resourceId
-
- Required: Yes
- Type: string
Identifier of the resource in use - resourceType
-
- Required: Yes
- Type: string
Type of the resource in use
EndpointTemporarilyUnavailableException
Description
The cluster endpoint isn't available. Try another cluster endpoint.
Members
- message
-
- Required: Yes
- Type: string
InternalServerException
Description
There was an unexpected error during processing of the request.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: int
Advice to clients on when the call can be safely retried
ResourceNotFoundException
Description
The request references a routing control or control panel that was not found.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Required: Yes
- Type: string
Hypothetical resource identifier that was not found - resourceType
-
- Required: Yes
- Type: string
Hypothetical resource type that was not found
RoutingControl
Description
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 set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.
Members
- ControlPanelArn
-
- Type: string
The Amazon Resource Name (ARN) of the control panel where the routing control is located.
- ControlPanelName
-
- Type: string
The name of the control panel where the routing control is located. Only ASCII characters are supported for control panel names.
- Owner
-
- Type: string
The Amazon Web Services account ID of the routing control owner.
- RoutingControlArn
-
- Type: string
The Amazon Resource Name (ARN) of the routing control.
- RoutingControlName
-
- Type: string
The name of the routing control.
- RoutingControlState
-
- Type: string
The current state of the routing control. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.
ServiceLimitExceededException
Description
The request can't update that many routing control states at the same time. Try again with fewer routing control states.
Members
- limitCode
-
- Required: Yes
- Type: string
The code of the limit that was exceeded.
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Type: string
The resource identifier of the limit that was exceeded.
- resourceType
-
- Type: string
The resource type of the limit that was exceeded.
- serviceCode
-
- Required: Yes
- Type: string
The service code of the limit that was exceeded.
ThrottlingException
Description
The request was denied because of request throttling.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: int
Advice to clients on when the call can be safely retried
UpdateRoutingControlStateEntry
Description
A routing control state entry.
Members
- RoutingControlArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for a routing control state entry.
- RoutingControlState
-
- Required: Yes
- Type: string
The routing control state in a set of routing control state entries.
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
ValidationExceptionField
Description
There was a validation error on the request.
Members
- message
-
- Required: Yes
- Type: string
Information about the validation exception.
- name
-
- Required: Yes
- Type: string
The field that had the validation exception.