Skip to content
v2.277.0

CloudFormationValidatePluginProps Struct ​

Properties for configuring the CloudFormationValidatePlugin.

Example ​

ts
const app = new App();

// Rules text, read from disk perhaps
declare const myRules: string;

Validations.of(app).addPlugins(new CloudFormationValidatePlugin({
  guardRules: [{
    name: 'My rules',
    content: myRules,
  }],
}));
python
from aws_cdk import ValidationRuleSource


# Rules text, read from disk perhaps
# my_rules: str
app = App()

Validations.of(app).add_plugins(CloudFormationValidatePlugin(
    guard_rules=[ValidationRuleSource(
        name="My rules",
        content=my_rules
    )]
))
java
// 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());
csharp
// Install: dotnet add package Amazon.CDK.Lib
// Rules text, read from disk perhaps
string myRules;
var app = new App();

Validations.Of(app).AddPlugins(new CloudFormationValidatePlugin(new CloudFormationValidatePluginProps {
    GuardRules = new [] { new ValidationRuleSource {
        Name = "My rules",
        Content = myRules
    } }
}));
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Rules text, read from disk perhaps
var myRules string
app := awscdk.NewApp()

awscdk.Validations_Of(app).AddPlugins(awscdk.NewCloudFormationValidatePlugin(&CloudFormationValidatePluginProps{
	GuardRules: []ValidationRuleSource{
		&ValidationRuleSource{
			Name: jsii.String("My rules"),
			Content: myRules,
		},
	},
}))

Properties ​

guardRulesoptionalValidationRuleSource[]guard_rulesoptionaltyping.List[ValidationRuleSource]guardRulesoptionalList<ValidationRuleSource>GuardRulesoptionalValidationRuleSource[]GuardRulesoptional*[]ValidationRuleSource #
Custom Guard rules to evaluate in addition to built-in rules.

Default: no guard rules

includeDefaultRulesoptionalbooleaninclude_default_rulesoptionalboolincludeDefaultRulesoptionalBooleanIncludeDefaultRulesoptionalboolIncludeDefaultRulesoptional*bool = true #
Whether to evaluate the default Rego rules that ship with the CDK.
notes

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().

regoRulesoptionalValidationRuleSource[]rego_rulesoptionaltyping.List[ValidationRuleSource]regoRulesoptionalList<ValidationRuleSource>RegoRulesoptionalValidationRuleSource[]RegoRulesoptional*[]ValidationRuleSource #
Custom Rego rules to evaluate in addition to built-in rules.

Default: no custom rules