Package software.amazon.awscdk

Interface CloudFormationValidatePluginProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudFormationValidatePluginProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-17T14:53:55.774Z")
@Stability(Stable)
public interface CloudFormationValidatePluginProps
extends software.amazon.jsii.JsiiSerializable

Properties for configuring the CloudFormationValidatePlugin.

Example:

 // Rules text, read from disk perhaps
 String myRules;
 App app = new App();
 Validations.of(app).addPlugins(CloudFormationValidatePlugin.Builder.create()
         .guardRules(List.of(ValidationRuleSource.builder()
                 .name("My rules")
                 .content(myRules)
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CloudFormationValidatePluginProps.Builder	builder()
default List<ValidationRuleSource>	getGuardRules()	Custom Guard rules to evaluate in addition to built-in rules.
default Boolean	getIncludeDefaultRules()	Whether to evaluate the default Rego rules that ship with the CDK.
default List<ValidationRuleSource>	getRegoRules()	Custom Rego rules to evaluate in addition to built-in rules.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGuardRules

@Stability(Stable)
@Nullable
default List<ValidationRuleSource> getGuardRules()

Custom Guard rules to evaluate in addition to built-in rules.

Default: - no guard rules

getIncludeDefaultRules

@Stability(Stable)
@Nullable
default Boolean getIncludeDefaultRules()

Whether to evaluate the default Rego rules that ship with the CDK.

Registering a CloudFormationValidatePlugin explicitly replaces the auto-registered default instance, so without this flag adding custom rules would silently drop the CDK default rules. Individual default rules can be suppressed by ID via Validations.of(scope).acknowledge().

Default: true

getRegoRules

@Stability(Stable)
@Nullable
default List<ValidationRuleSource> getRegoRules()

Custom Rego rules to evaluate in addition to built-in rules.

Default: - no custom rules

builder

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

Returns:

a CloudFormationValidatePluginProps.Builder of CloudFormationValidatePluginProps