@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.60.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66fff19edb0d71b46ed9912252464c512075e176d818f004a9974a76933129cf |
|
MD5 | e6e1edde51542fc8af469999a5fc3bac |
|
BLAKE2b-256 | ec8617ec9fe9352cd86c6d1963dc8f390fce1f761c65148371c306308dd70f73 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.60-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | abf0923d1eb4aff46bdf2b9ae2729f1eb6c04d9201ef438975b1f87b5d2af753 |
|
MD5 | 9aaa007365aee8060534369aa2b6463e |
|
BLAKE2b-256 | 5ac1671af5c8f2611a4543db769da386d850efff97f079f8825dd36c1809e43a |