@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.18.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 455d0d742bf9403f6c27cfe69d196e1545ec7a73acef1d74d6bd6b19963f42da |
|
MD5 | 54bcc9ce447c1fa0ff11be0f7d6d568b |
|
BLAKE2b-256 | fe522a92a47e48d9a0cb4fd3a6db18e9ba03eb5fd7c4e52e56b664157eadf545 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f02ee5678aca6303233109523e38ca5ad1d9979d9a4aabfd7c49a64fc85f248 |
|
MD5 | 4a5d3f98fd299c568420c3fbc0287d95 |
|
BLAKE2b-256 | cd183f636e0a64d3be3b616c0a9c18503eb156acac5d0bbdd771907676b247ac |