awscc.route53recoverycontrol_safetyrule¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - route53-recovery-control-config:DeleteSafetyRule
update¶
Parent base class for filters and actions.
definitions:
AssertionRule:
additionalProperties: false
description: An assertion rule enforces that, when a routing control state is
changed, that the criteria set by the rule configuration is met. Otherwise,
the change to the routing control is not accepted.
properties:
AssertedControls:
description: 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
AWS Regions.
insertionOrder: false
items:
type: string
type: array
WaitPeriodMs:
description: 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.
type: integer
required:
- AssertedControls
- WaitPeriodMs
type: object
GatingRule:
additionalProperties: false
description: A gating rule verifies that a set of gating controls evaluates as
true, based on a rule configuration that you specify. If the gating rule evaluates
to true, Amazon Route 53 Application Recovery Controller allows a set of routing
control state changes to run and complete against the set of target controls.
properties:
GatingControls:
description: The gating controls for the gating rule. That is, routing controls
that are evaluated by the rule configuration that you specify.
insertionOrder: false
items:
type: string
type: array
TargetControls:
description: "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 AWS 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. \nIn 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."
insertionOrder: false
items:
type: string
type: array
WaitPeriodMs:
description: 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.
type: integer
required:
- WaitPeriodMs
- TargetControls
- GatingControls
type: object
RuleConfig:
additionalProperties: false
description: The rule configuration for an assertion rule or gating rule. This
is the criteria that you set for specific assertion controls (routing controls)
or gating controls. This configuration specifies how many controls must be enabled
after a transaction completes.
properties:
Inverted:
description: Logical negation of the rule. If the rule would usually evaluate
true, it's evaluated as false, and vice versa.
type: boolean
Threshold:
description: The value of N, when you specify an ATLEAST rule type. That is,
Threshold is the number of controls that must be set when you specify an
ATLEAST type.
type: integer
Type:
description: 'A rule can be one of the following: ATLEAST, AND, or OR.'
enum:
- AND
- OR
- ATLEAST
type: string
required:
- Type
- Threshold
- Inverted
type: object
RuleType:
description: 'A rule can be one of the following: ATLEAST, AND, or OR.'
enum:
- AND
- OR
- ATLEAST
type: string
SafetyRuleName:
description: The name for the safety rule.
type: string
Tag:
additionalProperties: false
properties:
Key:
maxLength: 128
minLength: 1
type: string
Value:
maxLength: 256
type: string
required:
- Value
- Key
type: object
properties:
AssertionRule:
additionalProperties: false
description: An assertion rule enforces that, when a routing control state is
changed, that the criteria set by the rule configuration is met. Otherwise,
the change to the routing control is not accepted.
properties:
AssertedControls:
description: 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
AWS Regions.
insertionOrder: false
items:
type: string
type: array
WaitPeriodMs:
description: 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.
type: integer
required:
- AssertedControls
- WaitPeriodMs
type: object
GatingRule:
additionalProperties: false
description: A gating rule verifies that a set of gating controls evaluates as
true, based on a rule configuration that you specify. If the gating rule evaluates
to true, Amazon Route 53 Application Recovery Controller allows a set of routing
control state changes to run and complete against the set of target controls.
properties:
GatingControls:
description: The gating controls for the gating rule. That is, routing controls
that are evaluated by the rule configuration that you specify.
insertionOrder: false
items:
type: string
type: array
TargetControls:
description: "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 AWS 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. \nIn 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."
insertionOrder: false
items:
type: string
type: array
WaitPeriodMs:
description: 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.
type: integer
required:
- WaitPeriodMs
- TargetControls
- GatingControls
type: object
Name:
description: The name for the safety rule.
type: string
type:
enum:
- update
Permissions - route53-recovery-control-config:UpdateSafetyRule