Package software.amazon.awscdk

Interface CfnRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:01.528Z")
@Stability(Stable)
public interface CfnRuleProps
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 ICfnConditionExpression cfnConditionExpression;
 CfnRuleProps cfnRuleProps = CfnRuleProps.builder()
         .assertions(List.of(CfnRuleAssertion.builder()
                 .assert(cfnConditionExpression)
                 .assertDescription("assertDescription")
                 .build()))
         .ruleCondition(cfnConditionExpression)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRuleProps.Builder	A builder for CfnRuleProps
static final class	CfnRuleProps.Jsii$Proxy	An implementation for CfnRuleProps

Method Summary

Modifier and Type	Method	Description
static CfnRuleProps.Builder	builder()
default List<CfnRuleAssertion>	getAssertions()	Assertions which define the rule.
default ICfnConditionExpression	getRuleCondition()	If the rule condition evaluates to false, the rule doesn't take effect.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssertions

@Stability(Stable)
@Nullable
default List<CfnRuleAssertion> getAssertions()

Assertions which define the rule.

Default: - No assertions for the rule.

getRuleCondition

@Stability(Stable)
@Nullable
default ICfnConditionExpression getRuleCondition()

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

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.

builder

@Stability(Stable)
static CfnRuleProps.Builder builder()

Returns:

a CfnRuleProps.Builder of CfnRuleProps