CfnRuleProps

class aws_cdk.CfnRuleProps(*, assertions=None, rule_condition=None)

Bases: object

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

Parameters:

  • assertions (Optional[Sequence[Union[CfnRuleAssertion, Dict[str, Any]]]]) – Assertions which define the rule. Default: - No assertions for the rule.

  • rule_condition (Optional[ICfnConditionExpression]) – 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.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

# cfn_condition_expression: cdk.ICfnConditionExpression

cfn_rule_props = cdk.CfnRuleProps(
    assertions=[cdk.CfnRuleAssertion(
        assert=cfn_condition_expression,
        assert_description="assertDescription"
    )],
    rule_condition=cfn_condition_expression
)

Attributes

assertions

Assertions which define the rule.

Default:

  • No assertions for the rule.

rule_condition

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.