@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.18.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f9183336377ad7d9324bd1462e39395a4c9c884205b53533297b678be50a830 |
|
MD5 | 8bc402a087ff0e446f3812c2445f17ab |
|
BLAKE2b-256 | 8dcf1abe708a32a94e298400189bc42848e15d254a3c61df313dc13e891a7ffa |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | efe0a8d73e5fa49f2275f68c7f883cddfaa09715d63bf0b77f2369c1c8e307f1 |
|
MD5 | 372cf7d55be05bb8d86b50a771c5c19d |
|
BLAKE2b-256 | a2e775e320b8103219f5a68ed2cd45c8e6b4bdf6f7eac2188955ac1c8d9be2c0 |