Package software.amazon.awscdk.services.route53recoverycontrol

Class CfnSafetyRule.Builder

java.lang.Object

software.amazon.awscdk.services.route53recoverycontrol.CfnSafetyRule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSafetyRule>

Enclosing class:

CfnSafetyRule

@Stability(Stable)
public static final class CfnSafetyRule.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSafetyRule>

A fluent builder for CfnSafetyRule.

Method Summary

Modifier and Type	Method	Description
CfnSafetyRule.Builder	assertionRule(IResolvable assertionRule)	An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met.
CfnSafetyRule.Builder	assertionRule(CfnSafetyRule.AssertionRuleProperty assertionRule)	An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met.
CfnSafetyRule	build()
CfnSafetyRule.Builder	controlPanelArn(String controlPanelArn)	The Amazon Resource Name (ARN) of the control panel.
static CfnSafetyRule.Builder	create(software.constructs.Construct scope, String id)
CfnSafetyRule.Builder	gatingRule(IResolvable gatingRule)	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.
CfnSafetyRule.Builder	gatingRule(CfnSafetyRule.GatingRuleProperty gatingRule)	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.
CfnSafetyRule.Builder	name(String name)	The name of the assertion rule.
CfnSafetyRule.Builder	ruleConfig(IResolvable 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.
CfnSafetyRule.Builder	ruleConfig(CfnSafetyRule.RuleConfigProperty 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.
CfnSafetyRule.Builder	tags(List<? extends CfnTag> tags)	The tags associated with the safety rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnSafetyRule.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnSafetyRule.Builder.

controlPanelArn

@Stability(Stable)
public CfnSafetyRule.Builder controlPanelArn(String controlPanelArn)

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

Parameters:

controlPanelArn - The Amazon Resource Name (ARN) of the control panel. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnSafetyRule.Builder name(String name)

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)

Parameters:

name - The name of the assertion rule. This parameter is required.

Returns:

this

See Also:

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

ruleConfig

@Stability(Stable)
public CfnSafetyRule.Builder ruleConfig(IResolvable 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 AWS Regions have traffic flowing to them.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

ruleConfig

@Stability(Stable)
public CfnSafetyRule.Builder ruleConfig(CfnSafetyRule.RuleConfigProperty 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 AWS Regions have traffic flowing to them.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

assertionRule

@Stability(Stable)
public CfnSafetyRule.Builder assertionRule(IResolvable assertionRule)

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.

Parameters:

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

Returns:

this

See Also:

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

assertionRule

@Stability(Stable)
public CfnSafetyRule.Builder assertionRule(CfnSafetyRule.AssertionRuleProperty assertionRule)

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.

Parameters:

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

Returns:

this

See Also:

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

gatingRule

@Stability(Stable)
public CfnSafetyRule.Builder gatingRule(IResolvable gatingRule)

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.

Parameters:

gatingRule - 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. This parameter is required.

Returns:

this

See Also:

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

gatingRule

@Stability(Stable)
public CfnSafetyRule.Builder gatingRule(CfnSafetyRule.GatingRuleProperty gatingRule)

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.

Parameters:

gatingRule - 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. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnSafetyRule.Builder tags(List<? extends CfnTag> tags)

The tags associated with the safety rule.

Parameters:

tags - The tags associated with the safety rule. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSafetyRule build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnSafetyRule>

Returns:

a newly built instance of CfnSafetyRule.