AWS::Route53RecoveryControl::SafetyRule GatingRule - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Route53RecoveryControl::SafetyRule 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "GatingControls" : [ String, ... ],
  "TargetControls" : [ String, ... ],
  "WaitPeriodMs" : Integer
}

YAML

  GatingControls: 
    - String
  TargetControls: 
    - String
  WaitPeriodMs: Integer

Properties

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.

Required: Yes

Type: Array of String

Update requires: Some interruptions

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.

Required: Yes

Type: Array of String

Update requires: Some interruptions

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.

Required: Yes

Type: Integer

Update requires: No interruption