software.amazon.awscdk.services.route53recoverycontrol

Class CfnSafetyRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.route53recoverycontrol.CfnSafetyRule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.689Z")
 @Stability(value=Stable)
public class CfnSafetyRule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Route53RecoveryControl::SafetyRule`.

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

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.*;
 CfnSafetyRule cfnSafetyRule = CfnSafetyRule.Builder.create(this, "MyCfnSafetyRule")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnSafetyRule.AssertionRuleProperty An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met.
static class	CfnSafetyRule.Builder A fluent builder for CfnSafetyRule.
static interface	CfnSafetyRule.GatingRuleProperty 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.
static interface	CfnSafetyRule.RuleConfigProperty The rule configuration for an assertion rule.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSafetyRule(software.constructs.Construct scope, String id, CfnSafetyRuleProps props) Create a new `AWS::Route53RecoveryControl::SafetyRule`.
protected	CfnSafetyRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSafetyRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
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	getAttrSafetyRuleArn() The Amazon Resource Name (ARN) of the safety rule.
String	getAttrStatus() The deployment status of the safety rule.
protected Map<String,Object>	getCfnProperties()
String	getControlPanelArn() The Amazon Resource Name (ARN) for the control panel.
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.
TagManager	getTags() The value for a tag.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssertionRule(CfnSafetyRule.AssertionRuleProperty value) An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met.
void	setAssertionRule(IResolvable value) An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met.
void	setControlPanelArn(String value) The Amazon Resource Name (ARN) for the control panel.
void	setGatingRule(CfnSafetyRule.GatingRuleProperty value) 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.
void	setGatingRule(IResolvable value) 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.
void	setName(String value) The name of the assertion rule.
void	setRuleConfig(CfnSafetyRule.RuleConfigProperty value) 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.
void	setRuleConfig(IResolvable value) 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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSafetyRule

protected CfnSafetyRule(software.amazon.jsii.JsiiObjectRef objRef)

CfnSafetyRule

protected CfnSafetyRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSafetyRule

@Stability(value=Stable)
public CfnSafetyRule(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnSafetyRuleProps props)

Create a new `AWS::Route53RecoveryControl::SafetyRule`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrSafetyRuleArn

@Stability(value=Stable)
 @NotNull
public String getAttrSafetyRuleArn()

The Amazon Resource Name (ARN) of the safety rule.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The deployment status of the safety rule.

Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The value for a tag.

getControlPanelArn

@Stability(value=Stable)
 @NotNull
public String getControlPanelArn()

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

setControlPanelArn

@Stability(value=Stable)
public void setControlPanelArn(@NotNull
                                                        String value)

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

getName

@Stability(value=Stable)
 @NotNull
public String getName()

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.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

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.

getRuleConfig

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

setRuleConfig

@Stability(value=Stable)
public void setRuleConfig(@NotNull
                                                   CfnSafetyRule.RuleConfigProperty value)

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.

setRuleConfig

@Stability(value=Stable)
public void setRuleConfig(@NotNull
                                                   IResolvable value)

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.

getAssertionRule

@Stability(value=Stable)
 @Nullable
public 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.

setAssertionRule

@Stability(value=Stable)
public void setAssertionRule(@Nullable
                                                      CfnSafetyRule.AssertionRuleProperty value)

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.

setAssertionRule

@Stability(value=Stable)
public void setAssertionRule(@Nullable
                                                      IResolvable value)

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.

getGatingRule

@Stability(value=Stable)
 @Nullable
public 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.

setGatingRule

@Stability(value=Stable)
public void setGatingRule(@Nullable
                                                   CfnSafetyRule.GatingRuleProperty value)

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.

setGatingRule

@Stability(value=Stable)
public void setGatingRule(@Nullable
                                                   IResolvable value)

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.