@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.16.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c45dbe471331f52b0f5838c29337a21e80d8dee1a8b7d9fbba994db01237c09c |
|
MD5 | 274bb6eded9c8e5959d1b06285a1d7d3 |
|
BLAKE2b-256 | 5997152d0442eb6ab3ce6d0142b4037a9b63ab7d7527b20faa380c58613d0ae0 |
Hashes for aws_prototyping_sdk.pdk_nag-0.16.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8355de3ea7da7beebae96e89c0635d21ca838936806b7809c480b9da0004f1ea |
|
MD5 | deefec07e8b0e6e50b347b136bf67cc9 |
|
BLAKE2b-256 | 5d5baef96db4044299143ae6dd8ff7afe3a07a243223db99da82d3be6bb7073b |