@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.19.59.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7e5edc83f4a81ab838ef933933dd53ffae5069a57218bee8015e77970af8f5e |
|
MD5 | e543502a361d3e84703875c80f9ae197 |
|
BLAKE2b-256 | b2252f1e265bac7b6cb8bcdf36cfff2bcd93004981aeb0fcdffe4a69dbe4fffc |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.59-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56947da9583f424e35cd8d0f0bc5fcd9d7aba6b00074a8db809186625bb2a2f8 |
|
MD5 | 648fee215cd58726efb0fd09d01d88e5 |
|
BLAKE2b-256 | 87830140196fc9f730587eb33a27e9dfa0415b31aa29db6a12ed22cbc7c741b1 |