Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Route53RecoveryControlConfig.Types.NewGatingRule

Description

Synopsis

Documentation

data NewGatingRule Source #

A new gating rule for a control panel.

See: newNewGatingRule smart constructor.

Constructors

NewGatingRule'

Fields

targetControls :: [Text]
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.
controlPanelArn :: Text
The Amazon Resource Name (ARN) of the control panel.
gatingControls :: [Text]
The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
ruleConfig :: 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.
waitPeriodMs :: Int
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.
name :: Text
The name for the new gating rule.

Instances

Instances details

ToJSON NewGatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.NewGatingRule Methods toJSON :: NewGatingRule -> Value # toEncoding :: NewGatingRule -> Encoding # toJSONList :: [NewGatingRule] -> Value # toEncodingList :: [NewGatingRule] -> Encoding #
Generic NewGatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.NewGatingRule Associated Types type Rep NewGatingRule :: Type -> Type # Methods from :: NewGatingRule -> Rep NewGatingRule x # to :: Rep NewGatingRule x -> NewGatingRule #
Read NewGatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.NewGatingRule Methods readsPrec :: Int -> ReadS NewGatingRule # readList :: ReadS [NewGatingRule] # readPrec :: ReadPrec NewGatingRule # readListPrec :: ReadPrec [NewGatingRule] #
Show NewGatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.NewGatingRule Methods showsPrec :: Int -> NewGatingRule -> ShowS # show :: NewGatingRule -> String # showList :: [NewGatingRule] -> ShowS #
NFData NewGatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.NewGatingRule Methods rnf :: NewGatingRule -> () #
Eq NewGatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.NewGatingRule Methods (==) :: NewGatingRule -> NewGatingRule -> Bool # (/=) :: NewGatingRule -> NewGatingRule -> Bool #
Hashable NewGatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.NewGatingRule Methods hashWithSalt :: Int -> NewGatingRule -> Int # hash :: NewGatingRule -> Int #
type Rep NewGatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.NewGatingRule type Rep NewGatingRule = D1 ('MetaData "NewGatingRule" "Amazonka.Route53RecoveryControlConfig.Types.NewGatingRule" "amazonka-route53-recovery-control-config-2.0-EdxrPdjlafWED9VxY6nLf4" 'False) (C1 ('MetaCons "NewGatingRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "targetControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: (S1 ('MetaSel ('Just "controlPanelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "gatingControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))) :: (S1 ('MetaSel ('Just "ruleConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RuleConfig) :: (S1 ('MetaSel ('Just "waitPeriodMs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newNewGatingRule Source #

Arguments

:: Text	`$sel:controlPanelArn:NewGatingRule'`
-> RuleConfig	`$sel:ruleConfig:NewGatingRule'`
-> Int	`$sel:waitPeriodMs:NewGatingRule'`
-> Text	`$sel:name:NewGatingRule'`
-> NewGatingRule

Create a value of NewGatingRule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:targetControls:NewGatingRule', newGatingRule_targetControls - 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.

$sel:controlPanelArn:NewGatingRule', newGatingRule_controlPanelArn - The Amazon Resource Name (ARN) of the control panel.

$sel:gatingControls:NewGatingRule', newGatingRule_gatingControls - The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

$sel:ruleConfig:NewGatingRule', newGatingRule_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.

$sel:waitPeriodMs:NewGatingRule', newGatingRule_waitPeriodMs - 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.

$sel:name:NewGatingRule', newGatingRule_name - The name for the new gating rule.

newGatingRule_targetControls :: Lens' NewGatingRule [Text] Source #

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.

newGatingRule_controlPanelArn :: Lens' NewGatingRule Text Source #

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

newGatingRule_gatingControls :: Lens' NewGatingRule [Text] Source #

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

newGatingRule_ruleConfig :: Lens' NewGatingRule RuleConfig Source #

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.

newGatingRule_waitPeriodMs :: Lens' NewGatingRule Int Source #

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.

newGatingRule_name :: Lens' NewGatingRule Text Source #

The name for the new gating rule.