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,
}],
}));
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