@aws-prototyping-sdk/pdk-nag
Project description
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;
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws_prototyping_sdk.pdk_nag-0.13.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ac1ef1f1cec238d5dc65f0b22a41c4c04f95f57c6469b87bebe78b337ceb999 |
|
MD5 | e85543dd52336b6a27db4cd851e738ed |
|
BLAKE2b-256 | 4b996d5a38673b59ad6fc8c5f6cded1ef255e2f9d401e53f5194be846dbd2b03 |
Hashes for aws_prototyping_sdk.pdk_nag-0.13.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 404fa073ecdfbcc397bddb16a53b8f1c14d0e41d04409227b4f2c978164b83c9 |
|
MD5 | 98cbf8dcf1d3d639915b76f0d123f12f |
|
BLAKE2b-256 | d6b470149364558712a1b373c2a675bac9d1958ed026da8ea625bc5bc3187a75 |