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

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

Overview

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
}

A new gating rule for a control panel.

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)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1195

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

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


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1195

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

#nameString

The name for the new gating rule.

Returns:

  • (String)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1195

class NewGatingRule < Struct.new(
  :control_panel_arn,
  :gating_controls,
  :name,
  :rule_config,
  :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:



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1195

class NewGatingRule < Struct.new(
  :control_panel_arn,
  :gating_controls,
  :name,
  :rule_config,
  :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>)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1195

class NewGatingRule < Struct.new(
  :control_panel_arn,
  :gating_controls,
  :name,
  :rule_config,
  :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)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'gems/aws-sdk-route53recoverycontrolconfig/lib/aws-sdk-route53recoverycontrolconfig/types.rb', line 1195

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