@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.39.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32836b22b3f8e861559dfe6f30ab4741b10685ef00c48ef2f450a6921cc59876 |
|
MD5 | 09a80e8ba6ff78afc09070042e923349 |
|
BLAKE2b-256 | 76ec6891c79a999f3bdb4e3f12bd77da5d9ce1d333dbd823496d448aa3e9e785 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.39-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 503388910062754acbe35a97c8f8c219bfd766f84a0423a96d9f39ea9ec61f2d |
|
MD5 | c7511bf21892852695dc9fc41a0b648e |
|
BLAKE2b-256 | 6acf2ae5e665b64f02fae8bcf5bd8a686e7b6424144ed09da51d5ae1f53bc1f0 |