Class: Aws::Route53RecoveryControlConfig::Types::GatingRule

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#control_panel_arnString

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

Returns:

  • (String)


778
779
780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 778

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

#gating_controlsArray<String>

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

Returns:

  • (Array<String>)


778
779
780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 778

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

#nameString

The name for the gating rule.

Returns:

  • (String)


778
779
780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 778

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

#rule_configTypes::RuleConfig

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.

Returns:



778
779
780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 778

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

#safety_rule_arnString

The Amazon Resource Name (ARN) of the gating rule.

Returns:

  • (String)


778
779
780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 778

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

#statusString

The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

Returns:

  • (String)


778
779
780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 778

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

#target_controlsArray<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>)


778
779
780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 778

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

#wait_period_msInteger

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)


778
779
780
781
782
783
784
785
786
787
788
789
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 778

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