@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.16.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8193182b14862581f0acacbac2e6b082fd3232726f7aa365aaf087adaf73a09 |
|
MD5 | 3759f8cab267d9b9a672986c3430f6e8 |
|
BLAKE2b-256 | 697873abc7ef2c3f9767e2b1ac8cce41765df5a33da5f619d84320b5a33a55ca |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d45dd599ae8a23a44e2860a4fb964a91a62c531cf498ab9b017dd352a2f76bf |
|
MD5 | a85d5b68ba881c3cfcc1c3c347196497 |
|
BLAKE2b-256 | 73c3f611dd21688567f5d759fa4c0309600281bab35f4ffce1fc3d86b9468787 |