@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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 763cd2a0d83edf1b9c1b061edc2b616886c164407406364bcc494b74239bbc29 |
|
MD5 | 182c8fd8ea0e3bc69953ed57c8731634 |
|
BLAKE2b-256 | c53648c200b1ae770d630c3772ae48b1bb2d32e06e16eaca6369af6c0a66369f |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb7c57a7e801a5bb14b4b59356ef0b9adb81d05c626c9320451a1705e8a8a467 |
|
MD5 | 2f7ca19b0febfb3e6e524f2fd6953f60 |
|
BLAKE2b-256 | 9380bd03a195ee3d5ec9a139b936a6b36aa2c2f4373bd6a317732122389f123b |