aws-cdk-lib.CfnRuleProps

CfnRuleProps Struct

A rule can include a RuleCondition property and must include an Assertions property.

For each rule, you can define only one rule condition; you can define one or more asserts within the Assertions property. You define a rule condition and assertions by using rule-specific intrinsic functions.

You can use the following rule-specific intrinsic functions to define rule conditions and assertions:

Fn::And Fn::Contains Fn::EachMemberEquals Fn::EachMemberIn Fn::Equals Fn::If Fn::Not Fn::Or Fn::RefAll Fn::ValueOf Fn::ValueOfAll

https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html

CfnRuleProps

used as props by

• CfnRule

Source

core/lib/cfn-rule.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';

declare const cfnConditionExpression: cdk.ICfnConditionExpression;
const cfnRuleProps: cdk.CfnRuleProps = {
  assertions: [{
    assert: cfnConditionExpression,
    assertDescription: 'assertDescription',
  }],
  ruleCondition: cfnConditionExpression,
};

Properties

assertions?optionalCfnRuleAssertion[]assertions?optionaltyping.List[CfnRuleAssertion]assertions?optionalList<CfnRuleAssertion>Assertions?optionalCfnRuleAssertion[]Assertions?optional*[]CfnRuleAssertion#

Assertions which define the rule.

Default: No assertions for the rule.

ruleCondition?optionalICfnConditionExpressionrule_condition?optionalICfnConditionExpressionruleCondition?optionalICfnConditionExpressionRuleCondition?optionalICfnConditionExpressionRuleCondition?optionalICfnConditionExpression#

If the rule condition evaluates to false, the rule doesn't take effect.

Default: Rule's assertions will always take effect.

If the function in the rule condition evaluates to true, expressions in each assert are evaluated and applied.