@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.44.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b3ad6fc0260a44cd8350728475adc46f9b7af13bd545da8ce2257abca8a2792 |
|
MD5 | 3b6af1bffc33c5d24a05466317642669 |
|
BLAKE2b-256 | 99ba31dbc781314006278006d0c787e3ef3b58b06fa3014dc9baca359dd00644 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.44-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98e7ff1b79e00b6e2026cfd0a461cc0b9174f510f1da56c2b848ad0fdc44beb7 |
|
MD5 | 6790962ff0a5c7e18515d337014dac77 |
|
BLAKE2b-256 | 422fb1efca836a5db34bef756f248b116d1a7253ba99c29aaaf0e0e0cb12ed18 |