"WaitPeriodMs": integer, "Name": "string"
}}
DeleteSafetyRuleResponse schema
{ }
ValidationException schema
{ "message": "string"
}
ResourceNotFoundException schema
{ "message": "string"
}
InternalServerException schema
{ "message": "string"
}
Properties
AssertionRule
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.
Status
The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Type: Status (p. 60) Required: True
ControlPanelArn
The Amazon Resource Name (ARN) of the control panel.
Type: string Required: True
AssertedControls
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 AWS Regions.
Type: Array of type string Required: True
SafetyRuleArn
The Amazon Resource Name (ARN) of the assertion rule.
Type: string Required: True
RuleConfig
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 AWS Regions have traffic flowing to them.
Type: RuleConfig (p. 60) Required: True
WaitPeriodMs
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.
Type: integer Required: True Format: int32
Name
Name of the assertion rule. You can use any non-white space character in the name.
Type: string Required: True Pattern: ^\S+$
MinLength: 1 MaxLength: 64
DeleteSafetyRuleResponse
There is an empty response when you delete a safety rule.
DescribeSafetyRuleResponse
The response when you send a DescribeSafetyRuleResponse request.
AssertionRule
The assertion rule in the response.
Type: AssertionRule (p. 56) Required: False
GatingRule
The gating rule in the response.
Type: GatingRule (p. 58) Required: False
GatingRule
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.
Status
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
Type: Status (p. 60) Required: True
TargetControls
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.
Type: Array of type string Required: True
ControlPanelArn
The Amazon Resource Name (ARN) of the control panel.
Type: string Required: True
GatingControls
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.
Type: Array of type string Required: True
SafetyRuleArn
The Amazon Resource Name (ARN) of the gating rule.
Type: string Required: True
RuleConfig
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.
Type: RuleConfig (p. 60) Required: True
WaitPeriodMs
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.
Type: integer Required: True Format: int32
Name
The name of the gating rule. You can use any non-white space character in the name.
Type: string Required: True Pattern: ^\S+$
MinLength: 1 MaxLength: 64
InternalServerException
500 response - InternalServiceError. Temporary service error. Retry the request.
message
Type: string Required: TrueResourceNotFoundException
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
message
Type: stringRequired: True
RuleConfig
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.
Type
A rule can be one of the following: ATLEAST, AND, or OR.
Type: RuleType (p. 60) Required: True
Inverted
Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.
Type: boolean Required: True
Threshold
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: integer Required: True Format: int32
RuleType
An enumerated type that determines how the evaluated rules are processed. RuleType can be one of the following:
ATLEAST - At least N routing controls must be set. You specify N as the Threshold in the rule configuration.
AND - All routing controls must be set. This is a shortcut for "At least N," where N is the total number of controls in the rule.
OR - Any control must be set. This is a shortcut for "At least N," where N is 1.
ATLEAST AND OR
Status
The deployment status of a resource. Status can be one of the following:
PENDING: Amazon Route 53 Application Recovery Controller is creating the resource.
DEPLOYED: The resource is deployed and ready to use.
PENDING_DELETION: Amazon Route 53 Application Recovery Controller is deleting the resource.
PENDING DEPLOYED
PENDING_DELETION
ValidationException
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.
message
Type: string Required: TrueSee also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
DescribeSafetyRule
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteSafetyRule
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListAssociatedRoute53HealthChecks
URI
/routingcontrol/RoutingControlArn/associatedRoute53HealthChecks
HTTP methods
GET
Operation ID: ListAssociatedRoute53HealthChecks
Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
Path parameters
Name Type Required Description
RoutingControlArn String True The Amazon Resource
Name (ARN) of the routing control.