@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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f694c45c1a4457b9fe386b457d64a30e16b3d04cbcf0d39bfcd7db7c3852286 |
|
MD5 | 8afc4f980720c49165b224bc6e7108ca |
|
BLAKE2b-256 | 7f0ccb28cbbf386c293057a76b95e3d096e51dd83390cb35e40d4f99981f965b |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d655944eefc5a2f51544ac93d9a504abd225626c4dacaf9bf964a45d8037583 |
|
MD5 | 4ec1231826459178a0dd55cf480d61a3 |
|
BLAKE2b-256 | 664b50f310e61acc1efbe2b14a3c78592f5cc3cc804195d88e3e5aa32502dabc |