AWS Route53 Recovery Control Config 2020-11-02
- Client: Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
- Service ID: route53-recovery-control-config
- Version: 2020-11-02
This page describes the parameters and results for the operations of the AWS Route53 Recovery Control Config (2020-11-02), and shows how to use the Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient object to call the described operations. This documentation is specific to the 2020-11-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 */).
- CreateCluster ( array $params = [] )
Create a new cluster.
- CreateControlPanel ( array $params = [] )
Creates a new control panel.
- CreateRoutingControl ( array $params = [] )
Creates a new routing control.
- CreateSafetyRule ( array $params = [] )
Creates a safety rule in a control panel.
- DeleteCluster ( array $params = [] )
Delete a cluster.
- DeleteControlPanel ( array $params = [] )
Deletes a control panel.
- DeleteRoutingControl ( array $params = [] )
Deletes a routing control.
- DeleteSafetyRule ( array $params = [] )
Deletes a safety rule.
- DescribeCluster ( array $params = [] )
Display the details about a cluster.
- DescribeControlPanel ( array $params = [] )
Displays details about a control panel.
- DescribeRoutingControl ( array $params = [] )
Displays details about a routing control.
- DescribeSafetyRule ( array $params = [] )
Returns information about a safety rule.
- ListAssociatedRoute53HealthChecks ( array $params = [] )
Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
- ListClusters ( array $params = [] )
Returns an array of all the clusters in an account.
- ListControlPanels ( array $params = [] )
Returns an array of control panels in an account or in a cluster.
- ListRoutingControls ( array $params = [] )
Returns an array of routing controls for a control panel.
- ListSafetyRules ( array $params = [] )
List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
- ListTagsForResource ( array $params = [] )
Lists the tags for a resource.
- TagResource ( array $params = [] )
Adds a tag to a resource.
- UntagResource ( array $params = [] )
Removes a tag from a resource.
- UpdateControlPanel ( array $params = [] )
Updates a control panel.
- UpdateRoutingControl ( array $params = [] )
Updates a routing control.
- UpdateSafetyRule ( array $params = [] )
Update a safety rule (an assertion rule or gating rule).
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:
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
| Waiter name | API Operation | Delay | Max Attempts |
|---|---|---|---|
| ClusterCreated | DescribeCluster | 5 | 26 |
| ClusterDeleted | DescribeCluster | 5 | 26 |
| ControlPanelCreated | DescribeControlPanel | 5 | 26 |
| ControlPanelDeleted | DescribeControlPanel | 5 | 26 |
| RoutingControlCreated | DescribeRoutingControl | 5 | 26 |
| RoutingControlDeleted | DescribeRoutingControl | 5 | 26 |
Operations
CreateCluster
$result = $client->createCluster([/* ... */]); $promise = $client->createClusterAsync([/* ... */]);
Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.
Parameter Syntax
$result = $client->createCluster([
'ClientToken' => '<string>',
'ClusterName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
- ClusterName
-
- Required: Yes
- Type: string
The name of the cluster.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags associated with the cluster.
Result Syntax
[
'Cluster' => [
'ClusterArn' => '<string>',
'ClusterEndpoints' => [
[
'Endpoint' => '<string>',
'Region' => '<string>',
],
// ...
],
'Name' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
]
Result Details
Members
- Cluster
-
- Type: Cluster structure
The cluster that was created.
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
ServiceQuotaExceededException:
402 response - You attempted to create more resources than the service allows based on service quotas.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
CreateControlPanel
$result = $client->createControlPanel([/* ... */]); $promise = $client->createControlPanelAsync([/* ... */]);
Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.
Parameter Syntax
$result = $client->createControlPanel([
'ClientToken' => '<string>',
'ClusterArn' => '<string>', // REQUIRED
'ControlPanelName' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
- ClusterArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the cluster for the control panel.
- ControlPanelName
-
- Required: Yes
- Type: string
The name of the control panel.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags associated with the control panel.
Result Syntax
[
'ControlPanel' => [
'ClusterArn' => '<string>',
'ControlPanelArn' => '<string>',
'DefaultControlPanel' => true || false,
'Name' => '<string>',
'RoutingControlCount' => <integer>,
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
]
Result Details
Members
- ControlPanel
-
- Type: ControlPanel structure
Information about a control panel.
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
ServiceQuotaExceededException:
402 response - You attempted to create more resources than the service allows based on service quotas.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
CreateRoutingControl
$result = $client->createRoutingControl([/* ... */]); $promise = $client->createRoutingControlAsync([/* ... */]);
Creates a new routing control.
A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.
To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
Parameter Syntax
$result = $client->createRoutingControl([
'ClientToken' => '<string>',
'ClusterArn' => '<string>', // REQUIRED
'ControlPanelArn' => '<string>',
'RoutingControlName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
- ClusterArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the cluster that includes the routing control.
- ControlPanelArn
-
- Type: string
The Amazon Resource Name (ARN) of the control panel that includes the routing control.
- RoutingControlName
-
- Required: Yes
- Type: string
The name of the routing control.
Result Syntax
[
'RoutingControl' => [
'ControlPanelArn' => '<string>',
'Name' => '<string>',
'RoutingControlArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
]
Result Details
Members
- RoutingControl
-
- Type: RoutingControl structure
The routing control that is created.
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
ServiceQuotaExceededException:
402 response - You attempted to create more resources than the service allows based on service quotas.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
CreateSafetyRule
$result = $client->createSafetyRule([/* ... */]); $promise = $client->createSafetyRuleAsync([/* ... */]);
Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.
There are two types of safety rules: assertion rules and gating rules.
Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.
Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.
For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.
Parameter Syntax
$result = $client->createSafetyRule([
'AssertionRule' => [
'AssertedControls' => ['<string>', ...], // REQUIRED
'ControlPanelArn' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'RuleConfig' => [ // REQUIRED
'Inverted' => true || false, // REQUIRED
'Threshold' => <integer>, // REQUIRED
'Type' => 'ATLEAST|AND|OR', // REQUIRED
],
'WaitPeriodMs' => <integer>, // REQUIRED
],
'ClientToken' => '<string>',
'GatingRule' => [
'ControlPanelArn' => '<string>', // REQUIRED
'GatingControls' => ['<string>', ...], // REQUIRED
'Name' => '<string>', // REQUIRED
'RuleConfig' => [ // REQUIRED
'Inverted' => true || false, // REQUIRED
'Threshold' => <integer>, // REQUIRED
'Type' => 'ATLEAST|AND|OR', // REQUIRED
],
'TargetControls' => ['<string>', ...], // REQUIRED
'WaitPeriodMs' => <integer>, // REQUIRED
],
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- AssertionRule
-
- Type: NewAssertionRule structure
The assertion rule requested.
- ClientToken
-
- Type: string
A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
- GatingRule
-
- Type: NewGatingRule structure
The gating rule requested.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The tags associated with the safety rule.
Result Syntax
[
'AssertionRule' => [
'AssertedControls' => ['<string>', ...],
'ControlPanelArn' => '<string>',
'Name' => '<string>',
'RuleConfig' => [
'Inverted' => true || false,
'Threshold' => <integer>,
'Type' => 'ATLEAST|AND|OR',
],
'SafetyRuleArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
'WaitPeriodMs' => <integer>,
],
'GatingRule' => [
'ControlPanelArn' => '<string>',
'GatingControls' => ['<string>', ...],
'Name' => '<string>',
'RuleConfig' => [
'Inverted' => true || false,
'Threshold' => <integer>,
'Type' => 'ATLEAST|AND|OR',
],
'SafetyRuleArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
'TargetControls' => ['<string>', ...],
'WaitPeriodMs' => <integer>,
],
]
Result Details
Members
- AssertionRule
-
- Type: AssertionRule structure
The assertion rule created.
- GatingRule
-
- Type: GatingRule structure
The gating rule created.
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
DeleteCluster
$result = $client->deleteCluster([/* ... */]); $promise = $client->deleteClusterAsync([/* ... */]);
Delete a cluster.
Parameter Syntax
$result = $client->deleteCluster([
'ClusterArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
DeleteControlPanel
$result = $client->deleteControlPanel([/* ... */]); $promise = $client->deleteControlPanelAsync([/* ... */]);
Deletes a control panel.
Parameter Syntax
$result = $client->deleteControlPanel([
'ControlPanelArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
DeleteRoutingControl
$result = $client->deleteRoutingControl([/* ... */]); $promise = $client->deleteRoutingControlAsync([/* ... */]);
Deletes a routing control.
Parameter Syntax
$result = $client->deleteRoutingControl([
'RoutingControlArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
DeleteSafetyRule
$result = $client->deleteSafetyRule([/* ... */]); $promise = $client->deleteSafetyRuleAsync([/* ... */]);
Deletes a safety rule.
/>Parameter Syntax
$result = $client->deleteSafetyRule([
'SafetyRuleArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
DescribeCluster
$result = $client->describeCluster([/* ... */]); $promise = $client->describeClusterAsync([/* ... */]);
Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).
Parameter Syntax
$result = $client->describeCluster([
'ClusterArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Cluster' => [
'ClusterArn' => '<string>',
'ClusterEndpoints' => [
[
'Endpoint' => '<string>',
'Region' => '<string>',
],
// ...
],
'Name' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
]
Result Details
Members
- Cluster
-
- Type: Cluster structure
The cluster for the DescribeCluster request.
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
DescribeControlPanel
$result = $client->describeControlPanel([/* ... */]); $promise = $client->describeControlPanelAsync([/* ... */]);
Displays details about a control panel.
Parameter Syntax
$result = $client->describeControlPanel([
'ControlPanelArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ControlPanel' => [
'ClusterArn' => '<string>',
'ControlPanelArn' => '<string>',
'DefaultControlPanel' => true || false,
'Name' => '<string>',
'RoutingControlCount' => <integer>,
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
]
Result Details
Members
- ControlPanel
-
- Type: ControlPanel structure
Information about the control panel.
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
DescribeRoutingControl
$result = $client->describeRoutingControl([/* ... */]); $promise = $client->describeRoutingControlAsync([/* ... */]);
Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.
To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
Parameter Syntax
$result = $client->describeRoutingControl([
'RoutingControlArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'RoutingControl' => [
'ControlPanelArn' => '<string>',
'Name' => '<string>',
'RoutingControlArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
]
Result Details
Members
- RoutingControl
-
- Type: RoutingControl structure
Information about the routing control.
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
DescribeSafetyRule
$result = $client->describeSafetyRule([/* ... */]); $promise = $client->describeSafetyRuleAsync([/* ... */]);
Returns information about a safety rule.
Parameter Syntax
$result = $client->describeSafetyRule([
'SafetyRuleArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AssertionRule' => [
'AssertedControls' => ['<string>', ...],
'ControlPanelArn' => '<string>',
'Name' => '<string>',
'RuleConfig' => [
'Inverted' => true || false,
'Threshold' => <integer>,
'Type' => 'ATLEAST|AND|OR',
],
'SafetyRuleArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
'WaitPeriodMs' => <integer>,
],
'GatingRule' => [
'ControlPanelArn' => '<string>',
'GatingControls' => ['<string>', ...],
'Name' => '<string>',
'RuleConfig' => [
'Inverted' => true || false,
'Threshold' => <integer>,
'Type' => 'ATLEAST|AND|OR',
],
'SafetyRuleArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
'TargetControls' => ['<string>', ...],
'WaitPeriodMs' => <integer>,
],
]
Result Details
Members
- AssertionRule
-
- Type: AssertionRule structure
The assertion rule in the response.
- GatingRule
-
- Type: GatingRule structure
The gating rule in the response.
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
ListAssociatedRoute53HealthChecks
$result = $client->listAssociatedRoute53HealthChecks([/* ... */]); $promise = $client->listAssociatedRoute53HealthChecksAsync([/* ... */]);
Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
Parameter Syntax
$result = $client->listAssociatedRoute53HealthChecks([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'RoutingControlArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'HealthCheckIds' => ['<string>', ...],
'NextToken' => '<string>',
]
Result Details
Members
Errors
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
ListClusters
$result = $client->listClusters([/* ... */]); $promise = $client->listClustersAsync([/* ... */]);
Returns an array of all the clusters in an account.
Parameter Syntax
$result = $client->listClusters([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Clusters' => [
[
'ClusterArn' => '<string>',
'ClusterEndpoints' => [
[
'Endpoint' => '<string>',
'Region' => '<string>',
],
// ...
],
'Name' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Clusters
-
- Type: Array of Cluster structures
An array of the clusters in an account.
- NextToken
-
- Type: string
The token that identifies which batch of results you want to see.
Errors
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
ListControlPanels
$result = $client->listControlPanels([/* ... */]); $promise = $client->listControlPanelsAsync([/* ... */]);
Returns an array of control panels in an account or in a cluster.
Parameter Syntax
$result = $client->listControlPanels([
'ClusterArn' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'ControlPanels' => [
[
'ClusterArn' => '<string>',
'ControlPanelArn' => '<string>',
'DefaultControlPanel' => true || false,
'Name' => '<string>',
'RoutingControlCount' => <integer>,
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- ControlPanels
-
- Type: Array of ControlPanel structures
The result of a successful ListControlPanel request.
- NextToken
-
- Type: string
The token that identifies which batch of results you want to see.
Errors
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
ListRoutingControls
$result = $client->listRoutingControls([/* ... */]); $promise = $client->listRoutingControlsAsync([/* ... */]);
Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.
Parameter Syntax
$result = $client->listRoutingControls([
'ControlPanelArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'NextToken' => '<string>',
'RoutingControls' => [
[
'ControlPanelArn' => '<string>',
'Name' => '<string>',
'RoutingControlArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token that identifies which batch of results you want to see.
- RoutingControls
-
- Type: Array of RoutingControl structures
An array of routing controls.
Errors
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
ListSafetyRules
$result = $client->listSafetyRules([/* ... */]); $promise = $client->listSafetyRulesAsync([/* ... */]);
List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
Parameter Syntax
$result = $client->listSafetyRules([
'ControlPanelArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'NextToken' => '<string>',
'SafetyRules' => [
[
'ASSERTION' => [
'AssertedControls' => ['<string>', ...],
'ControlPanelArn' => '<string>',
'Name' => '<string>',
'RuleConfig' => [
'Inverted' => true || false,
'Threshold' => <integer>,
'Type' => 'ATLEAST|AND|OR',
],
'SafetyRuleArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
'WaitPeriodMs' => <integer>,
],
'GATING' => [
'ControlPanelArn' => '<string>',
'GatingControls' => ['<string>', ...],
'Name' => '<string>',
'RuleConfig' => [
'Inverted' => true || false,
'Threshold' => <integer>,
'Type' => 'ATLEAST|AND|OR',
],
'SafetyRuleArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
'TargetControls' => ['<string>', ...],
'WaitPeriodMs' => <integer>,
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token that identifies which batch of results you want to see.
- SafetyRules
-
- Type: Array of Rule structures
The list of safety rules in a control panel.
Errors
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags for a resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds a tag to a resource.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes a tag from a resource.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
UpdateControlPanel
$result = $client->updateControlPanel([/* ... */]); $promise = $client->updateControlPanelAsync([/* ... */]);
Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.
Parameter Syntax
$result = $client->updateControlPanel([
'ControlPanelArn' => '<string>', // REQUIRED
'ControlPanelName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ControlPanel' => [
'ClusterArn' => '<string>',
'ControlPanelArn' => '<string>',
'DefaultControlPanel' => true || false,
'Name' => '<string>',
'RoutingControlCount' => <integer>,
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
]
Result Details
Members
- ControlPanel
-
- Type: ControlPanel structure
The control panel to update.
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
UpdateRoutingControl
$result = $client->updateRoutingControl([/* ... */]); $promise = $client->updateRoutingControlAsync([/* ... */]);
Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.
Parameter Syntax
$result = $client->updateRoutingControl([
'RoutingControlArn' => '<string>', // REQUIRED
'RoutingControlName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'RoutingControl' => [
'ControlPanelArn' => '<string>',
'Name' => '<string>',
'RoutingControlArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
],
]
Result Details
Members
- RoutingControl
-
- Type: RoutingControl structure
The routing control that was updated.
Errors
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
-
403 response - You do not have sufficient access to perform this action.
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
429 response - LimitExceededException or TooManyRequestsException.
-
409 response - ConflictException. You might be using a predefined variable.
UpdateSafetyRule
$result = $client->updateSafetyRule([/* ... */]); $promise = $client->updateSafetyRuleAsync([/* ... */]);
Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.
Parameter Syntax
$result = $client->updateSafetyRule([
'AssertionRuleUpdate' => [
'Name' => '<string>', // REQUIRED
'SafetyRuleArn' => '<string>', // REQUIRED
'WaitPeriodMs' => <integer>, // REQUIRED
],
'GatingRuleUpdate' => [
'Name' => '<string>', // REQUIRED
'SafetyRuleArn' => '<string>', // REQUIRED
'WaitPeriodMs' => <integer>, // REQUIRED
],
]);
Parameter Details
Members
- AssertionRuleUpdate
-
- Type: AssertionRuleUpdate structure
The assertion rule to update.
- GatingRuleUpdate
-
- Type: GatingRuleUpdate structure
The gating rule to update.
Result Syntax
[
'AssertionRule' => [
'AssertedControls' => ['<string>', ...],
'ControlPanelArn' => '<string>',
'Name' => '<string>',
'RuleConfig' => [
'Inverted' => true || false,
'Threshold' => <integer>,
'Type' => 'ATLEAST|AND|OR',
],
'SafetyRuleArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
'WaitPeriodMs' => <integer>,
],
'GatingRule' => [
'ControlPanelArn' => '<string>',
'GatingControls' => ['<string>', ...],
'Name' => '<string>',
'RuleConfig' => [
'Inverted' => true || false,
'Threshold' => <integer>,
'Type' => 'ATLEAST|AND|OR',
],
'SafetyRuleArn' => '<string>',
'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
'TargetControls' => ['<string>', ...],
'WaitPeriodMs' => <integer>,
],
]
Result Details
Members
- AssertionRule
-
- Type: AssertionRule structure
The assertion rule updated.
- GatingRule
-
- Type: GatingRule structure
The gating rule updated.
Errors
-
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
-
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
-
500 response - InternalServiceError. Temporary service error. Retry the request.
Shapes
AccessDeniedException
Description
403 response - You do not have sufficient access to perform this action.
Members
AssertionRule
Description
An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control is not accepted. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.
Members
- AssertedControls
-
- Required: Yes
- Type: Array of strings
The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
- ControlPanelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the control panel.
- Name
-
- Required: Yes
- Type: string
Name of the assertion rule. You can use any non-white space character in the name.
- RuleConfig
-
- Required: Yes
- Type: RuleConfig structure
The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.
- SafetyRuleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the assertion rule.
- Status
-
- Required: Yes
- Type: string
The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
- WaitPeriodMs
-
- Required: Yes
- Type: int
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
AssertionRuleUpdate
Description
An update to an assertion rule. You can update the name or the evaluation period (wait period). If you don't specify one of the items to update, the item is unchanged.
Members
- Name
-
- Required: Yes
- Type: string
The name of the assertion rule. You can use any non-white space character in the name.
- SafetyRuleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the assertion rule.
- WaitPeriodMs
-
- Required: Yes
- Type: int
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
Cluster
Description
A set of five redundant Regional endpoints against which you can execute API calls to update or get the state of routing controls. You can host multiple control panels and routing controls on one cluster.
Members
- ClusterArn
-
- Type: string
The Amazon Resource Name (ARN) of the cluster.
- ClusterEndpoints
-
- Type: Array of ClusterEndpoint structures
Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.
- Name
-
- Type: string
The name of the cluster.
- Status
-
- Type: string
Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
ClusterEndpoint
Description
A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.
Members
- Endpoint
-
- Type: string
A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.
- Region
-
- Type: string
The Amazon Web Services Region for a cluster endpoint.
ConflictException
Description
409 response - ConflictException. You might be using a predefined variable.
Members
ControlPanel
Description
A control panel represents a group of routing controls that can be changed together in a single transaction.
Members
- ClusterArn
-
- Type: string
The Amazon Resource Name (ARN) of the cluster that includes the control panel.
- ControlPanelArn
-
- Type: string
The Amazon Resource Name (ARN) of the control panel.
- DefaultControlPanel
-
- Type: boolean
A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.
- Name
-
- Type: string
The name of the control panel. You can use any non-white space character in the name.
- RoutingControlCount
-
- Type: int
The number of routing controls in the control panel.
- Status
-
- Type: string
The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
GatingRule
Description
A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.
For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.
Members
- ControlPanelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the control panel.
- GatingControls
-
- Required: Yes
- Type: Array of strings
An array of gating routing control Amazon Resource Names (ARNs). For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.
- Name
-
- Required: Yes
- Type: string
The name for the gating rule. You can use any non-white space character in the name.
- RuleConfig
-
- Required: Yes
- Type: RuleConfig structure
The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.
- SafetyRuleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the gating rule.
- Status
-
- Required: Yes
- Type: string
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
- TargetControls
-
- Required: Yes
- Type: Array of strings
An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.
- WaitPeriodMs
-
- Required: Yes
- Type: int
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
GatingRuleUpdate
Description
Update to a gating rule. You can update the name or the evaluation period (wait period). If you don't specify one of the items to update, the item is unchanged.
Members
- Name
-
- Required: Yes
- Type: string
The name for the gating rule. You can use any non-white space character in the name.
- SafetyRuleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the gating rule.
- WaitPeriodMs
-
- Required: Yes
- Type: int
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
InternalServerException
Description
500 response - InternalServiceError. Temporary service error. Retry the request.
Members
NewAssertionRule
Description
A new assertion rule for a control panel.
Members
- AssertedControls
-
- Required: Yes
- Type: Array of strings
The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
- ControlPanelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the control panel.
- Name
-
- Required: Yes
- Type: string
The name of the assertion rule. You can use any non-white space character in the name.
- RuleConfig
-
- Required: Yes
- Type: RuleConfig structure
The criteria that you set for specific assertion controls (routing controls) that designate how many control states must be ON as the result of a transaction. For example, if you have three assertion controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion controls must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.
- WaitPeriodMs
-
- Required: Yes
- Type: int
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
NewGatingRule
Description
A new gating rule for a control panel.
Members
- ControlPanelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the control panel.
- GatingControls
-
- Required: Yes
- Type: Array of strings
The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
- Name
-
- Required: Yes
- Type: string
The name for the new gating rule.
- RuleConfig
-
- Required: Yes
- Type: RuleConfig structure
The criteria that you set for specific gating controls (routing controls) that designate how many control states must be ON to allow you to change (set or unset) the target control states.
- TargetControls
-
- Required: Yes
- Type: Array of strings
Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
- WaitPeriodMs
-
- Required: Yes
- Type: int
An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
ResourceNotFoundException
Description
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
Members
RoutingControl
Description
A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.
Members
- ControlPanelArn
-
- Type: string
The Amazon Resource Name (ARN) of the control panel that includes the routing control.
- Name
-
- Type: string
The name of the routing control.
- RoutingControlArn
-
- Type: string
The Amazon Resource Name (ARN) of the routing control.
- Status
-
- Type: string
The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Rule
Description
A safety rule. A safety rule can be an assertion rule or a gating rule.
Members
- ASSERTION
-
- Type: AssertionRule structure
An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.
- GATING
-
- Type: GatingRule structure
A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.
For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.
RuleConfig
Description
The rule configuration for an assertion rule. That is, the criteria that you set for specific assertion controls (routing controls) that specify how many control states must be ON after a transaction completes.
Members
- Inverted
-
- Required: Yes
- Type: boolean
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
- Threshold
-
- Required: Yes
- Type: int
The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.
- Type
-
- Required: Yes
- Type: string
A rule can be one of the following: ATLEAST, AND, or OR.
ServiceQuotaExceededException
Description
402 response - You attempted to create more resources than the service allows based on service quotas.
Members
ThrottlingException
Description
429 response - LimitExceededException or TooManyRequestsException.