class Aws::Route53RecoveryControlConfig::Types::NewGatingRule
A new gating rule for a control panel.
@note When making an API call, you may pass NewGatingRule
data as a hash: { control_panel_arn: "__string", # required gating_controls: ["__string"], # required name: "__stringMin1Max64PatternS", # required rule_config: { # required inverted: false, # required threshold: 1, # required type: "ATLEAST", # required, accepts ATLEAST, AND, OR }, target_controls: ["__string"], # required wait_period_ms: 1, # required }
@!attribute [rw] control_panel_arn
The Amazon Resource Name (ARN) of the control panel. @return [String]
@!attribute [rw] gating_controls
The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify. @return [Array<String>]
@!attribute [rw] name
The name for the new gating rule. @return [String]
@!attribute [rw] rule_config
The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls. @return [Types::RuleConfig]
@!attribute [rw] target_controls
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. @return [Array<String>]
@!attribute [rw] wait_period_ms
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. @return [Integer]
@see docs.aws.amazon.com/goto/WebAPI/route53-recovery-control-config-2020-11-02/NewGatingRule AWS API Documentation
Constants
- SENSITIVE