@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.17.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43527aa12db423b9a097e0f2e7a093f0ed0b88445957414681a26d6ec204adb3 |
|
MD5 | d5995a9beb22c28d92d031e2f2e42184 |
|
BLAKE2b-256 | 59ed486982baa63bb0d78e50b2c16be03927458799a3c470595619588cc89e48 |
Hashes for aws_prototyping_sdk.pdk_nag-0.17.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8997f45a27be6d6359b3e66ce4e373b5b0aca7910d384fe49dcd30e5d332c5e2 |
|
MD5 | 348dc1de11bcabc87086b9d67f988b2d |
|
BLAKE2b-256 | 9f3e97c6f69d1d9ef8374ae1e369161f23dcae76cffb8ab57885601c6be7bd2f |