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 |
Synopsis
- data NewAssertionRule = NewAssertionRule' {
- controlPanelArn :: Text
- assertedControls :: [Text]
- ruleConfig :: RuleConfig
- waitPeriodMs :: Int
- name :: Text
- newNewAssertionRule :: Text -> RuleConfig -> Int -> Text -> NewAssertionRule
- newAssertionRule_controlPanelArn :: Lens' NewAssertionRule Text
- newAssertionRule_assertedControls :: Lens' NewAssertionRule [Text]
- newAssertionRule_ruleConfig :: Lens' NewAssertionRule RuleConfig
- newAssertionRule_waitPeriodMs :: Lens' NewAssertionRule Int
- newAssertionRule_name :: Lens' NewAssertionRule Text
Documentation
data NewAssertionRule Source #
A new assertion rule for a control panel.
See: newNewAssertionRule
smart constructor.
NewAssertionRule' | |
|
Instances
:: Text | |
-> RuleConfig | |
-> Int | |
-> Text | |
-> NewAssertionRule |
Create a value of NewAssertionRule
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:controlPanelArn:NewAssertionRule'
, newAssertionRule_controlPanelArn
- The Amazon Resource Name (ARN) for the control panel.
$sel:assertedControls:NewAssertionRule'
, newAssertionRule_assertedControls
- The routing controls that are part of transactions that are evaluated to
determine if a request to change a routing control state is allowed. For
example, you might include three routing controls, one for each of three
Amazon Web Services Regions.
$sel:ruleConfig:NewAssertionRule'
, newAssertionRule_ruleConfig
- The criteria that you set for specific assertion controls (routing
controls) that designate how many control states must be ON as the
result of a transaction. For example, if you have three assertion
controls, you might specify ATLEAST 2 for your rule configuration. This
means that at least two assertion controls must be ON, so that at least
two Amazon Web Services Regions have traffic flowing to them.
$sel:waitPeriodMs:NewAssertionRule'
, newAssertionRule_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:NewAssertionRule'
, newAssertionRule_name
- The name of the assertion rule. You can use any non-white space
character in the name.
newAssertionRule_controlPanelArn :: Lens' NewAssertionRule Text Source #
The Amazon Resource Name (ARN) for the control panel.
newAssertionRule_assertedControls :: Lens' NewAssertionRule [Text] Source #
The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
newAssertionRule_ruleConfig :: Lens' NewAssertionRule RuleConfig Source #
The criteria that you set for specific assertion controls (routing controls) that designate how many control states must be ON as the result of a transaction. For example, if you have three assertion controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion controls must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.
newAssertionRule_waitPeriodMs :: Lens' NewAssertionRule 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.
newAssertionRule_name :: Lens' NewAssertionRule Text Source #
The name of the assertion rule. You can use any non-white space character in the name.