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

Description

Synopsis

data GatingRule = GatingRule' {
- status :: Status
- targetControls :: [Text]
- controlPanelArn :: Text
- safetyRuleArn :: Text
- gatingControls :: [Text]
- ruleConfig :: RuleConfig
- waitPeriodMs :: Int
- name :: Text
}
newGatingRule :: Status -> Text -> Text -> RuleConfig -> Int -> Text -> GatingRule
gatingRule_status :: Lens' GatingRule Status
gatingRule_targetControls :: Lens' GatingRule [Text]
gatingRule_controlPanelArn :: Lens' GatingRule Text
gatingRule_safetyRuleArn :: Lens' GatingRule Text
gatingRule_gatingControls :: Lens' GatingRule [Text]
gatingRule_ruleConfig :: Lens' GatingRule RuleConfig
gatingRule_waitPeriodMs :: Lens' GatingRule Int
gatingRule_name :: Lens' GatingRule Text

Documentation

data GatingRule Source #

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: newGatingRule smart constructor.

Constructors

GatingRule'

Fields

status :: Status
The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.
targetControls :: [Text]
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.
controlPanelArn :: Text
The Amazon Resource Name (ARN) of the control panel.
safetyRuleArn :: Text
The Amazon Resource Name (ARN) of the gating rule.
gatingControls :: [Text]
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.
ruleConfig :: 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.
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 gating rule. You can use any non-white space character in the name.

Instances

Instances details

FromJSON GatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.GatingRule Methods parseJSON :: Value -> Parser GatingRule # parseJSONList :: Value -> Parser [GatingRule] #
Generic GatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.GatingRule Associated Types type Rep GatingRule :: Type -> Type # Methods from :: GatingRule -> Rep GatingRule x # to :: Rep GatingRule x -> GatingRule #
Read GatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.GatingRule Methods readsPrec :: Int -> ReadS GatingRule # readList :: ReadS [GatingRule] # readPrec :: ReadPrec GatingRule # readListPrec :: ReadPrec [GatingRule] #
Show GatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.GatingRule Methods showsPrec :: Int -> GatingRule -> ShowS # show :: GatingRule -> String # showList :: [GatingRule] -> ShowS #
NFData GatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.GatingRule Methods rnf :: GatingRule -> () #
Eq GatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.GatingRule Methods (==) :: GatingRule -> GatingRule -> Bool # (/=) :: GatingRule -> GatingRule -> Bool #
Hashable GatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.GatingRule Methods hashWithSalt :: Int -> GatingRule -> Int # hash :: GatingRule -> Int #
type Rep GatingRule Source #
Instance details Defined in Amazonka.Route53RecoveryControlConfig.Types.GatingRule type Rep GatingRule = D1 ('MetaData "GatingRule" "Amazonka.Route53RecoveryControlConfig.Types.GatingRule" "amazonka-route53-recovery-control-config-2.0-EdxrPdjlafWED9VxY6nLf4" 'False) (C1 ('MetaCons "GatingRule'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status) :: S1 ('MetaSel ('Just "targetControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])) :: (S1 ('MetaSel ('Just "controlPanelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "safetyRuleArn") '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)))))

newGatingRule Source #

Arguments

:: Status	`$sel:status:GatingRule'`
-> Text	`$sel:controlPanelArn:GatingRule'`
-> Text	`$sel:safetyRuleArn:GatingRule'`
-> RuleConfig	`$sel:ruleConfig:GatingRule'`
-> Int	`$sel:waitPeriodMs:GatingRule'`
-> Text	`$sel:name:GatingRule'`
-> GatingRule

Create a value of GatingRule 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:status:GatingRule', gatingRule_status - The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

$sel:targetControls:GatingRule', gatingRule_targetControls - 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.

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

$sel:safetyRuleArn:GatingRule', gatingRule_safetyRuleArn - The Amazon Resource Name (ARN) of the gating rule.

$sel:gatingControls:GatingRule', gatingRule_gatingControls - 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.

$sel:ruleConfig:GatingRule', gatingRule_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.

$sel:waitPeriodMs:GatingRule', gatingRule_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:GatingRule', gatingRule_name - The name for the gating rule. You can use any non-white space character in the name.

gatingRule_status :: Lens' GatingRule Status Source #

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

gatingRule_targetControls :: Lens' GatingRule [Text] Source #

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.

gatingRule_controlPanelArn :: Lens' GatingRule Text Source #

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

gatingRule_safetyRuleArn :: Lens' GatingRule Text Source #

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

gatingRule_gatingControls :: Lens' GatingRule [Text] Source #

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.

gatingRule_ruleConfig :: Lens' GatingRule RuleConfig Source #

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.

gatingRule_waitPeriodMs :: Lens' GatingRule 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.

gatingRule_name :: Lens' GatingRule Text Source #

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