@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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | df96833a39c84e32d25898afdd8c6ad553361571818e9bf78071c97c08ca3391 |
|
MD5 | 2d756c999185c2126d68a591c7e5a1d9 |
|
BLAKE2b-256 | 6b8b6e68d11f5703872e18f29b58ca546a8b19d5078ee442afae379ba3c9648a |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54b2ecb80f46b8d92c03179feb0b41e5a481017925e482b71b95c9e0c25d0427 |
|
MD5 | dfa351af17fbd8b0a43c0d0c67f40635 |
|
BLAKE2b-256 | 8ac85e0b2a307d9527d2b02fac67789d0d7e55242a6a8d7a509c2b41045661eb |