@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.12.22.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4be68dd364a357e977ddaa4d3e3d65d25cad11d17d9956d17c4683b38445eea9 |
|
MD5 | 9d144a3587648e0ef5315b3265e3bf72 |
|
BLAKE2b-256 | ef1920ebafcd89aca4bce2748c6ae4b034dcf6e41dd28a1ae8b0308f41f812a8 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.22-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ffcfc4c42746c3947cf7a3d8c7e0b9ee19e3743dbdc2f71f1f925c146bbace5 |
|
MD5 | 12022e2aaae7b8536b90f367749485eb |
|
BLAKE2b-256 | 34db180dbd0c2ecb51fba310b20049db838199d3f98144e7fda6521ad5839cfe |