@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.17.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdb6a9308891b25e54fbff280ff14c46002b740affbde9c77e6a6743f14569ab |
|
MD5 | c3fafaa031d63934fec101d093dcf5e7 |
|
BLAKE2b-256 | 72df7a483f8b70434af955df72c97ca96bc71606b5718c56932e77272d980280 |
Hashes for aws_prototyping_sdk.pdk_nag-0.17.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 050b1239fed8ea15dfd2754638dde8fa57cf25fa6472a163fabd091fee36672e |
|
MD5 | e183df34d9284965fa27faba4feaaad0 |
|
BLAKE2b-256 | afd564c8ced37816e7a8d4888e586803dbfc84c9128f85313c4e84237c934c17 |