@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.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e947a5e2e7e3bc501f9af5ca5adaa5595be49bed2d48d7a623b8435d15cf01f |
|
MD5 | 4e3ade545c9f7980a00b7195915469c5 |
|
BLAKE2b-256 | 81b0acf9243c9c71b99d9860342b88e722bdeb42c3ed2a4267a76c7432c3f59a |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a3857766e9d315b210155e5e6bdf41723c857f674b7651428ee155294ef168e |
|
MD5 | 241a39051bee2657734b1b87eb3ebcac |
|
BLAKE2b-256 | 01badce7cfb20563eec26aee7d27f99d41d0b6efacbe16e75fc3e8d9d39fdf46 |