@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.12.35.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1eb6b811b375a1f62f97805c5d40d8d8e3e7e42a5862038db46bbc0c5cba649a |
|
MD5 | 7ef7d70cd333c286bb59fc999745b348 |
|
BLAKE2b-256 | 02b2b7f7e53891a68991fc9a56af3797296642464c6172eb46f0bf9f66435c1a |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.35-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47c2c04bea351c5fb246c46dd4785f7c581a4926f9c3195bb1bcb3ece3ea7ee0 |
|
MD5 | c7ae62ddfa4f7ced444dfd45db65e11b |
|
BLAKE2b-256 | e89672ab56b21966d1cef6dd3c4114f6fb83bc014ca170da3bb8cd7a96caf565 |