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 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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#control_panel_arn ⇒ String

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

Returns:

  • (String) 


696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 696

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

#gating_controls ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 696

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

#name ⇒ String

The name for the gating rule. You can use any non-white space character in the name.

Returns:

  • (String) 


696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 696

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

#owner ⇒ String

The Amazon Web Services account ID of the gating rule owner.

Returns:

  • (String) 


696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 696

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

#rule_config ⇒ Types::RuleConfig

The criteria that you set for gating routing controls that designate how many of the routing control states must be ON to allow you to update target routing control states.

Returns:



696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 696

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

#safety_rule_arn ⇒ String

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

Returns:

  • (String) 


696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 696

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

#status ⇒ String

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

Returns:

  • (String) 


696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 696

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

#target_controls ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 696

class GatingRule < Struct.new(
  :control_panel_arn,
  :gating_controls,
  :name,
  :rule_config,
  :safety_rule_arn,
  :status,
  :target_controls,
  :wait_period_ms,
  :owner)
  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) 


696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 696

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