@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.52.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae0aeceef865fc79053e347fdf00498b492394fe392d110f0dba1d950a88d77b |
|
MD5 | eebe5bdf5254dc2c950349748189e8e9 |
|
BLAKE2b-256 | d1a8c7b6266a90df7fbdcee93209f94b7760036704a75d7ec18082c8c949ede5 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.52-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 108e4d63deeefdfa42b66d29f7d912d74f384b5483102f5ec59c07b34896a872 |
|
MD5 | a9c9e88f8386ba517cba9d0d8138f8c2 |
|
BLAKE2b-256 | 93c5463972de9b7d97a9b720ef286b740818f660da0a33a998864ec38098685a |