@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.19.67.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72b17718deb0c3bb17feb832b59376e9177d9cc9c35bed02e63ca1c5567470ab |
|
MD5 | ece0cfa58bc8a5ecbc588d8456114a06 |
|
BLAKE2b-256 | 023301b2b0ba9a6afedcea5b18e1f60676a76a7afd83c3ead41473b13bb90707 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.67-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0bc7351bce2e71ec788902e3caf55ceace6093a89c0256a4d63bb40fdbe78e3b |
|
MD5 | a4bf069a9403e560b2a17d2d6cb19ad1 |
|
BLAKE2b-256 | 4331e5d887b8ad5aa41f90c1d1031eb7aee58d50e13160a1980d30f828983575 |