Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-route53recoverycontrol-safetyrule.json
Parent schema serverless-framework-configuration
Type: object

Resource schema for AWS Route53 Recovery Control basic constructs and validation rules.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53-recovery-control.git

Properties

AssertionRule object

An assertion rule enforces that, when a routing control state is changed, that the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.

2 nested properties
WaitPeriodMs integer required

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.

AssertedControls string[] required

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.

GatingRule object

A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.

3 nested properties
GatingControls string[] required

The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

TargetControls string[] required

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 AWS 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 integer required

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.

Name string | Aws_CF_FunctionString

The name for the safety rule.

ControlPanelArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the control panel.

RuleConfig object

The rule configuration for an assertion rule or gating rule. This is the criteria that you set for specific assertion controls (routing controls) or gating controls. This configuration specifies how many controls must be enabled after a transaction completes.

3 nested properties
Type string | Aws_CF_FunctionString required

A rule can be one of the following: ATLEAST, AND, or OR.

Threshold integer required

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.

Inverted boolean required

Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

Tags Tag[]

A collection of tags associated with a resource

One of

1. variant
2. variant

Definitions

SafetyRuleName string | Aws_CF_FunctionString

The name for the safety rule.

RuleType string | Aws_CF_FunctionString

A rule can be one of the following: ATLEAST, AND, or OR.

RuleConfig object

The rule configuration for an assertion rule or gating rule. This is the criteria that you set for specific assertion controls (routing controls) or gating controls. This configuration specifies how many controls must be enabled after a transaction completes.

Type string | Aws_CF_FunctionString required

A rule can be one of the following: ATLEAST, AND, or OR.

Threshold integer required

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.

Inverted boolean required

Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

GatingRule object

A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.

GatingControls string[] required

The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

TargetControls string[] required

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 AWS 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 integer required

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.

AssertionRule object

An assertion rule enforces that, when a routing control state is changed, that the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.

WaitPeriodMs integer required

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.

AssertedControls string[] required

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.

Tag object
Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required