Class CfnSafetyRule.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSafetyRule>
- Enclosing class:
CfnSafetyRule
CfnSafetyRule
.-
Method Summary
Modifier and TypeMethodDescriptionassertionRule
(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.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.build()
controlPanelArn
(String controlPanelArn) The Amazon Resource Name (ARN) for the control panel.static 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.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.The name of the assertion rule.ruleConfig
(IResolvable ruleConfig) The criteria that you set for specific assertion controls (routing controls) that designate how many control states must beON
as the result of a transaction.ruleConfig
(CfnSafetyRule.RuleConfigProperty ruleConfig) The criteria that you set for specific assertion controls (routing controls) that designate how many control states must beON
as the result of a transaction.The value for a tag.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnSafetyRule.Builder
.
-
controlPanelArn
The Amazon Resource Name (ARN) for the control panel.- Parameters:
controlPanelArn
- The Amazon Resource Name (ARN) for the control panel. This parameter is required.- Returns:
this
-
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
-
ruleConfig
The criteria that you set for specific assertion controls (routing controls) that designate how many control states must beON
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 beON
, 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 beON
as the result of a transaction. This parameter is required.- Returns:
this
-
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 beON
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 beON
, 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 beON
as the result of a transaction. This parameter is required.- Returns:
this
-
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
-
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
-
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 toOR
, that indicates that you must set the gating routing control toOn
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
-
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 toOR
, that indicates that you must set the gating routing control toOn
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
-
tags
The value for a tag.- Parameters:
tags
- The value for a tag. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnSafetyRule>
- Returns:
- a newly built instance of
CfnSafetyRule
.
-