# CloudFormationValidatePluginProps

Properties for configuring the CloudFormationValidatePlugin.

Used as props by: [CloudFormationValidatePlugin](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CloudFormationValidatePlugin.html)

- Source: [`core/lib/validation/cloudformation-validate-plugin.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/aws-cdk-lib/core/lib/validation/cloudformation-validate-plugin.ts#L42)
- Type last changed: v2.270.0 · 17 Sep 2026

## Example

TypeScript:

```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:

```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:

```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());
```

C# / .NET:

```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
    } }
}));
```

Golang:

```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

- `guardRules`: [ValidationRuleSource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.ValidationRuleSource.html)[] — Custom Guard rules to evaluate in addition to built-in rules.

  **Default:** no guard rules

- `includeDefaultRules`: boolean = true — 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()`.

- `regoRules`: [ValidationRuleSource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.ValidationRuleSource.html)[] — Custom Rego rules to evaluate in addition to built-in rules.

  **Default:** no custom rules
