@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.15.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fed5c20cfb9bf5110d6a99a2148f52414c32fb93375cf22564ac357bcb5594e3 |
|
MD5 | 749dba43fdaa8387ca5127235c76d901 |
|
BLAKE2b-256 | 14bdac52482edf5fe24d568f3ce51a5a02d39d9f9ea16181226d609dab7d553d |
Hashes for aws_prototyping_sdk.pdk_nag-0.15.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1a0c98de05951a81ffc5ce5ab8923dc2447a516b4fd2df040da398d3a91f469 |
|
MD5 | 88d311822321f424bf1b6ccc1464ff83 |
|
BLAKE2b-256 | 8602ce3c261b7936661cbd5239bfd4ed6cac86fa6a7e911898be490c892ff95f |