@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.65.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc61dbd5f7a918faa77787911b5868e382d6f0aa0dadb346b8a16d971599f6d9 |
|
MD5 | 71eea2462b114652731bed0975fc580c |
|
BLAKE2b-256 | 28703e585cbee43f29956c1872d317f4f9f601af54b78ba7dddabdec7a14ae23 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.65-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b3d50cfed033770f37cacec51e9b92255723d2e4834a9f298475729ee0eb6c6 |
|
MD5 | 4f8bb037818a679a4014622bbcc6378b |
|
BLAKE2b-256 | 3ee8c75cd3b817cda11cfd3b55a964c6f1346daf3f1b4613f1beeaefafaf022b |