Package software.amazon.awscdk

Class CloudFormationValidatePlugin.Builder

java.lang.Object

software.amazon.awscdk.CloudFormationValidatePlugin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudFormationValidatePlugin>

Enclosing class:

CloudFormationValidatePlugin

@Stability(Stable)
public static final class CloudFormationValidatePlugin.Builder
extends Object
implements software.amazon.jsii.Builder<CloudFormationValidatePlugin>

A fluent builder for CloudFormationValidatePlugin.

Method Summary

Modifier and Type	Method	Description
CloudFormationValidatePlugin	build()
static CloudFormationValidatePlugin.Builder	create()
CloudFormationValidatePlugin.Builder	guardRules(List<? extends ValidationRuleSource> guardRules)	Custom Guard rules to evaluate in addition to built-in rules.
CloudFormationValidatePlugin.Builder	includeDefaultRules(Boolean includeDefaultRules)	Whether to evaluate the default Rego rules that ship with the CDK.
CloudFormationValidatePlugin.Builder	regoRules(List<? extends ValidationRuleSource> regoRules)	Custom Rego rules to evaluate in addition to built-in rules.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CloudFormationValidatePlugin.Builder create()

Returns:

a new instance of CloudFormationValidatePlugin.Builder.

guardRules

@Stability(Stable)
public CloudFormationValidatePlugin.Builder guardRules(List<? extends ValidationRuleSource> guardRules)

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

Default: - no guard rules

Parameters:

guardRules - Custom Guard rules to evaluate in addition to built-in rules. This parameter is required.

Returns:

this

includeDefaultRules

@Stability(Stable)
public CloudFormationValidatePlugin.Builder includeDefaultRules(Boolean includeDefaultRules)

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

Parameters:

includeDefaultRules - Whether to evaluate the default Rego rules that ship with the CDK. This parameter is required.

Returns:

this

regoRules

@Stability(Stable)
public CloudFormationValidatePlugin.Builder regoRules(List<? extends ValidationRuleSource> regoRules)

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

Default: - no custom rules

Parameters:

regoRules - Custom Rego rules to evaluate in addition to built-in rules. This parameter is required.

Returns:

this

build

@Stability(Stable)
public CloudFormationValidatePlugin build()

Specified by:

build in interface software.amazon.jsii.Builder<CloudFormationValidatePlugin>

Returns:

a newly built instance of CloudFormationValidatePlugin.