Package software.amazon.awscdk.services.route53recoverycontrol

Interface CfnSafetyRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSafetyRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:34.687Z")
@Stability(Stable)
public interface CfnSafetyRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSafetyRule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.route53recoverycontrol.*;
 CfnSafetyRuleProps cfnSafetyRuleProps = CfnSafetyRuleProps.builder()
         .controlPanelArn("controlPanelArn")
         .name("name")
         .ruleConfig(RuleConfigProperty.builder()
                 .inverted(false)
                 .threshold(123)
                 .type("type")
                 .build())
         // the properties below are optional
         .assertionRule(AssertionRuleProperty.builder()
                 .assertedControls(List.of("assertedControls"))
                 .waitPeriodMs(123)
                 .build())
         .gatingRule(GatingRuleProperty.builder()
                 .gatingControls(List.of("gatingControls"))
                 .targetControls(List.of("targetControls"))
                 .waitPeriodMs(123)
                 .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	CfnSafetyRuleProps.Builder	A builder for CfnSafetyRuleProps
static final class	CfnSafetyRuleProps.Jsii$Proxy	An implementation for CfnSafetyRuleProps

Method Summary

Modifier and Type	Method	Description
static CfnSafetyRuleProps.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.
String	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.
String	getName()	The name of the assertion rule.
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

getControlPanelArn

@Stability(Stable)
@NotNull
String getControlPanelArn()

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

See Also:

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

getName

@Stability(Stable)
@NotNull
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)
@NotNull
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.

See Also:

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

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.

See Also:

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

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.

See Also:

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

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 CfnSafetyRuleProps.Builder builder()

Returns:

a CfnSafetyRuleProps.Builder of CfnSafetyRuleProps