Package software.amazon.awscdk.cfnpropertymixins.services.route53recoverycontrol

Interface CfnSafetyRuleMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSafetyRuleMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-14T18:32:18.474Z")
@Stability(Stable)
public interface CfnSafetyRuleMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnSafetyRulePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.route53recoverycontrol.*;
 CfnSafetyRuleMixinProps cfnSafetyRuleMixinProps = CfnSafetyRuleMixinProps.builder()
         .assertionRule(AssertionRuleProperty.builder()
                 .assertedControls(List.of("assertedControls"))
                 .waitPeriodMs(123)
                 .build())
         .controlPanelArn("controlPanelArn")
         .gatingRule(GatingRuleProperty.builder()
                 .gatingControls(List.of("gatingControls"))
                 .targetControls(List.of("targetControls"))
                 .waitPeriodMs(123)
                 .build())
         .name("name")
         .ruleConfig(RuleConfigProperty.builder()
                 .inverted(false)
                 .threshold(123)
                 .type("type")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSafetyRuleMixinProps.Builder	A builder for CfnSafetyRuleMixinProps
static final class	CfnSafetyRuleMixinProps.Jsii$Proxy	An implementation for CfnSafetyRuleMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnSafetyRuleMixinProps.Builder	builder()
default Object	getAssertionRule()	An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met.
default Object	getControlPanelArn()	The Amazon Resource Name (ARN) of the control panel.
default Object	getGatingRule()	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.
default String	getName()	The name of the assertion rule.
default Object	getRuleConfig()	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.
default List<CfnTag>	getTags()	The tags associated with the safety rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssertionRule

@Stability(Stable)
@Nullable
default Object getAssertionRule()

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.

Returns union: either IResolvable or CfnSafetyRulePropsMixin.AssertionRuleProperty

See Also:

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

getControlPanelArn

@Stability(Stable)
@Nullable
default Object getControlPanelArn()

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

Returns union: either String or IControlPanelRef

See Also:

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

getGatingRule

@Stability(Stable)
@Nullable
default Object getGatingRule()

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.

Returns union: either IResolvable or CfnSafetyRulePropsMixin.GatingRuleProperty

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the assertion rule.

The name must be unique within a control panel. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon)

See Also:

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

getRuleConfig

@Stability(Stable)
@Nullable
default Object getRuleConfig()

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.

Returns union: either IResolvable or CfnSafetyRulePropsMixin.RuleConfigProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags associated with the safety rule.

See Also:

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

builder

@Stability(Stable)
static CfnSafetyRuleMixinProps.Builder builder()

Returns:

a CfnSafetyRuleMixinProps.Builder of CfnSafetyRuleMixinProps