@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.16.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10b66ec807a0ef5083589c1e2abb4152cd82a38d4ae8a069d6815d299b3c481a |
|
MD5 | bc91727bf722d2426d7ee30d3caea6ca |
|
BLAKE2b-256 | 3969aa3181424aa52f124e70e341d3f639277b6e8c7ab01fd83c6e16a63f279b |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fed237c20e3f8c5a839b0019c38debe4e85b2d486cda1ed555c6b3dc1ec684b0 |
|
MD5 | 45aed2af80e9602fd3d8e2c43131cf1d |
|
BLAKE2b-256 | 2b1c68a41104ee486cd8aefd90cfd9296155d67e05d3414178ee88fd44670612 |