@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.14.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8fbfd6a63282847dc2ab51b20f9a50dc04e9e9fbfa1ce5ac4bbdbd0cebfdc07 |
|
MD5 | af9a9c73a0cba7494915fb6d43f353b8 |
|
BLAKE2b-256 | 297272bc0ee64af0e71489d8b695a4e891af65f09893dd64607cd9ff2e350a80 |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25fa6a9262607b0f3ffbe5e585f5775e811e12be4a4987dc946f3aa798412189 |
|
MD5 | 07290005a284d5658a55e9c2adc2e14b |
|
BLAKE2b-256 | 62a810598b71d20ad0321c4f43a6bd9dddfd35f038544a384a229fd5a040f5a5 |