@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.57.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f995778025ccdc4a109de4a9f82cfb2da993c2fa49d8f3ca6ddf6b55a00d89d3 |
|
MD5 | ddd938caf6fd2ecc094d78c8c4673b59 |
|
BLAKE2b-256 | dce29c049f81035a7c4a4b8dfdac6ee06e2145aef5af16dc9e6c6cf8ed3cba34 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.57-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cf4a2218d139e9e06ec0118db892c9b235c254fc3f975cbd378096c9a7a8269 |
|
MD5 | 1706a56e50ad79fe1e9cbdaa65fa263e |
|
BLAKE2b-256 | 6800778b58e9c0d6236e1ff639d1b4335dee198427f8b623fe536e6dfddf0032 |