@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.15.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3674c112bfe7db365de844847b4b19a628b88986dbf0453aac904d979d2fee6f |
|
MD5 | 2a55234422b113e1dfbe9779591bd7d6 |
|
BLAKE2b-256 | 56af83bdce3abda442847430be08c993dd34f927aee879fec0942d507e9792fb |
Hashes for aws_prototyping_sdk.pdk_nag-0.15.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66181a98a09905854276f3b37f98ee05c1637eab5a5d511c3af7fa9040b5c2e9 |
|
MD5 | ff2ddfb41033cdd238c9d298f1315a39 |
|
BLAKE2b-256 | 21f3ceb493990c8b757515693656e76a96f6dee6d30369eb6f10ea454535232f |