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

Description

Synopsis

data Rule = Rule' {
- assertion :: Maybe AssertionRule
- gating :: Maybe GatingRule
}
newRule :: Rule
rule_assertion :: Lens' Rule (Maybe AssertionRule)
rule_gating :: Lens' Rule (Maybe GatingRule)

Documentation

data Rule Source #

A safety rule. A safety rule can be an assertion rule or a gating rule.

See: newRule smart constructor.

Constructors

Rule'

Fields

assertion :: Maybe AssertionRule
An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.
gating :: Maybe GatingRule
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.

Instances

Instances details

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

newRule :: Rule Source #

Create a value of Rule 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:assertion:Rule', rule_assertion - An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

$sel:gating:Rule', rule_gating - 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.

rule_assertion :: Lens' Rule (Maybe AssertionRule) Source #

An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

rule_gating :: Lens' Rule (Maybe 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.