Package software.aws.awsprototypingsdk.pdknag

PDK Nag

PDKNag ships with a helper utility that automatically configures CDKNag within your application. 

 const app = PDKNag.app();
 const stack = new Stack(app, 'MyStack');
 ...

As shown above, this will configure your application to have CDKNag run on synthesis.

By default, CDK will trigger a failure on synth if any errors are encountered. To relax these, run the following: 

 cdk synth --ignore-errors

Conversely, CDK will not fail on synth if warnings are detected. To enforce that all warnings are resolved, run the following command: 

 cdk synth --strict

Instrumenting custom NagPacks

By default, when creating a PDKNag application the AwsSolutions NagPack is instrumented. In order to specify custom NagPacks to instrument, you can configure the PDKApp as follows: 

 import { PDKNag, AwsPrototypingChecks } from "@aws-prototyping-sdk/pdk-nag";
 
 const app = PDKNag.app({
     nagPacks: [new AwsPrototypingChecks()]
 });

In this example, the AwsPrototypingChecks NagPack has been configured to run instead of the default. Multiple NagPacks can also be instrumented by adding NagPack instances to the nagPacks array;