Interface ICfnRuleProps

Namespace

Amazon.CDK

Assembly

Amazon.CDK.dll

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

public interface ICfnRuleProps

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;

             ICfnConditionExpression cfnConditionExpression;
             var cfnRuleProps = new CfnRuleProps {
                 Assertions = new [] { new CfnRuleAssertion {
                     Assert = cfnConditionExpression,
                     AssertDescription = "assertDescription"
                 } },
                 RuleCondition = cfnConditionExpression
             };

Remarks

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

ExampleMetadata: fixture=_generated

Properties

Assertions

Assertions which define the rule.

ICfnRuleAssertion[]? Assertions { get; }

Property Value

ICfnRuleAssertion[]

Remarks

Default: - No assertions for the rule.

RuleCondition

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

ICfnConditionExpression? RuleCondition { get; }

Property Value

ICfnConditionExpression

Remarks

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

Default: - Rule's assertions will always take effect.