@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.41.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a12ccb7d1ebd8f3947b43a75c8548f2ae83bcb78a0b0c46ff8c3ded335ad671f |
|
MD5 | 395c648fddc9577697ebb7ffac1b1a7b |
|
BLAKE2b-256 | 0c461152149811a2881ec6d0a929b8383b3fc5c1b57c885cd006978a6a6fc5b5 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.41-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7c43e02679dc213725c410e933b24eb1c369a8af6ed5cf0d4ec141bcb229b6a |
|
MD5 | aa99f880692e2f22afe76b5e4c99ace4 |
|
BLAKE2b-256 | 70fdd7d2f517761767628df0fa24e8684f294515af3cc03a8133bdaaa0c08bf0 |