@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.14.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43716c4d60db7dbabc73b7e1d94a29d25f7f2d8fc63f482950044a7d5c7498b6 |
|
MD5 | b43e43ae9744d712884bd14da4cff9b4 |
|
BLAKE2b-256 | c010f7ede6c1d12c24b3b9b845f2e52b6ea75becd21541ff7c3cdab34504a1ce |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b1ce75aac5aedf6ebaab82df05b4b8f7285980c149825165844c62d57acbae8 |
|
MD5 | eb15757195fa8f22a0f5f2c9abe049e7 |
|
BLAKE2b-256 | 380a37943f50b4ca7e4ac943184f391b400fb712991c75768ab3b1009b3f284b |