@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.19.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45f01074ad958309dea6e99beee582968098382cdefe42bc89d31e3667496287 |
|
MD5 | 2e2118ffc10362b661a9a360bf7c02a5 |
|
BLAKE2b-256 | 6b6cb91bc85dfffb02720d3f1e7caaa2ddf0c14e30df19cf947a5859edb5fb0d |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70c1838a9b1fca92f5ffc80275d515b799f924a8403e546b58b77df5bcf442a2 |
|
MD5 | 31fe462affc920e1753ee2ab21129f8a |
|
BLAKE2b-256 | c6b886ca198dd461c9f8e6767610800b1e90660c823ada2d84b641282d85a441 |