@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.23.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f76c5e2a06e1b683f3c694477d6902516a2cb6c94c036a93ad70a380c0fb9f29 |
|
MD5 | fc74928db2ee5491b3974ecd713ae8e1 |
|
BLAKE2b-256 | cb2e0ef1fedb4d4781426ff5ce083b520e5191d6095a64be9d31e5151229d39e |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.23-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4fde8121b4634fb84cabbf469226b6e3ee5802ca44f40b4dbf218d5c2bebee64 |
|
MD5 | 808e3b234101b948e4003cae38647ce4 |
|
BLAKE2b-256 | eaab3aa4062a8f17d2305bd88269ca9650b6dc0b2778d4708e861de6f6006da8 |