Class: Aws::Route53RecoveryControlConfig::Types::NewGatingRule

Inherits:

Struct

• Object
• Struct
• Aws::Route53RecoveryControlConfig::Types::NewGatingRule

Defined in:

gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb

Overview

A new gating rule for a control panel.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #control_panel_arn ⇒ String

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

• #gating_controls ⇒ Array<String>

  The gating controls for the new gating rule.

• #name ⇒ String

  The name for the new gating rule.

• #rule_config ⇒ Types::RuleConfig

  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.

• #target_controls ⇒ Array<String>

  Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls.

• #wait_period_ms ⇒ Integer

  An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail.

Instance Attribute Details

#control_panel_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1083

class NewGatingRule < Struct.new(
  :control_panel_arn,
  :gating_controls,
  :name,
  :rule_config,
  :target_controls,
  :wait_period_ms)
  SENSITIVE = []
  include Aws::Structure
end

#gating_controls ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1083

class NewGatingRule < Struct.new(
  :control_panel_arn,
  :gating_controls,
  :name,
  :rule_config,
  :target_controls,
  :wait_period_ms)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name for the new gating rule.

Returns:

• (String)

# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1083

class NewGatingRule < Struct.new(
  :control_panel_arn,
  :gating_controls,
  :name,
  :rule_config,
  :target_controls,
  :wait_period_ms)
  SENSITIVE = []
  include Aws::Structure
end

#rule_config ⇒ Types::RuleConfig

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.

Returns:

• (Types::RuleConfig)

# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1083

class NewGatingRule < Struct.new(
  :control_panel_arn,
  :gating_controls,
  :name,
  :rule_config,
  :target_controls,
  :wait_period_ms)
  SENSITIVE = []
  include Aws::Structure
end

#target_controls ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1083

class NewGatingRule < Struct.new(
  :control_panel_arn,
  :gating_controls,
  :name,
  :rule_config,
  :target_controls,
  :wait_period_ms)
  SENSITIVE = []
  include Aws::Structure
end

#wait_period_ms ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1083

class NewGatingRule < Struct.new(
  :control_panel_arn,
  :gating_controls,
  :name,
  :rule_config,
  :target_controls,
  :wait_period_ms)
  SENSITIVE = []
  include Aws::Structure
end