CfnSafetyRuleProps

class aws_cdk.aws_route53recoverycontrol.CfnSafetyRuleProps(*, control_panel_arn, name, rule_config, assertion_rule=None, gating_rule=None, tags=None)

Bases: object

Properties for defining a CfnSafetyRule.

Parameters
  • control_panel_arn (str) – The Amazon Resource Name (ARN) for the control panel.

  • name (str) – The name of the assertion rule. You can use any non-white space character in the name. The name must be unique within a control panel.

  • rule_config (Union[IResolvable, RuleConfigProperty, Dict[str, Any]]) – 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 AWS Regions have traffic flowing to them.

  • assertion_rule (Union[IResolvable, AssertionRuleProperty, Dict[str, Any], None]) – An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control 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_rule (Union[IResolvable, GatingRuleProperty, Dict[str, Any], None]) – 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.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The value for a tag.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoverycontrol-safetyrule.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_route53recoverycontrol as route53recoverycontrol

cfn_safety_rule_props = route53recoverycontrol.CfnSafetyRuleProps(
    control_panel_arn="controlPanelArn",
    name="name",
    rule_config=route53recoverycontrol.CfnSafetyRule.RuleConfigProperty(
        inverted=False,
        threshold=123,
        type="type"
    ),

    # the properties below are optional
    assertion_rule=route53recoverycontrol.CfnSafetyRule.AssertionRuleProperty(
        asserted_controls=["assertedControls"],
        wait_period_ms=123
    ),
    gating_rule=route53recoverycontrol.CfnSafetyRule.GatingRuleProperty(
        gating_controls=["gatingControls"],
        target_controls=["targetControls"],
        wait_period_ms=123
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

assertion_rule

An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met.

Otherwise, the change to the routing control 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoverycontrol-safetyrule.html#cfn-route53recoverycontrol-safetyrule-assertionrule

Return type

Union[IResolvable, AssertionRuleProperty, None]

control_panel_arn

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoverycontrol-safetyrule.html#cfn-route53recoverycontrol-safetyrule-controlpanelarn

Return type

str

gating_rule

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoverycontrol-safetyrule.html#cfn-route53recoverycontrol-safetyrule-gatingrule

Return type

Union[IResolvable, GatingRuleProperty, None]

name

The name of the assertion rule.

You can use any non-white space character in the name. The name must be unique within a control panel.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoverycontrol-safetyrule.html#cfn-route53recoverycontrol-safetyrule-name

Return type

str

rule_config

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 AWS Regions have traffic flowing to them.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoverycontrol-safetyrule.html#cfn-route53recoverycontrol-safetyrule-ruleconfig

Return type

Union[IResolvable, RuleConfigProperty]

tags

The value for a tag.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53recoverycontrol-safetyrule.html#cfn-route53recoverycontrol-safetyrule-tags

Return type

Optional[List[CfnTag]]