@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.30.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 603f4a2e86146625580703d120658ca8e9288f3a348ffb8169b3dfba2c9d2214 |
|
MD5 | 742a152d870f21a81e86430b8f9e6b26 |
|
BLAKE2b-256 | ac974ae2cbf8119614024bad0cdf8f700b79138a99362a68cc99378dc3585ca8 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.30-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2daab6a2538e71e2ee0072694422942f2794a6b46b02b5e8a1899173ef3e4d7 |
|
MD5 | c6c202e6d6ce45f9460cb38407c29a97 |
|
BLAKE2b-256 | 26a053dd39e470d7f6e9d7a81f6f3ee49c874cd57f7b3d637e250a04b0a7f391 |