@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.14.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56095a87203d2f24356e4785206194e4f3363427f6a3a55f7f80016efb9e995c |
|
MD5 | 1080cb450c63c90864468f74fde48d96 |
|
BLAKE2b-256 | c2c195954cf3d5f095f064f03b5c6ec3bb37f3488787f19f066ec6517a096953 |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cff545b50784b5ef2411abe6e026109e211b3cc03f632a427303b1ab558d2018 |
|
MD5 | 8f0ccc150ec3b4ce0605d349e87ef3bb |
|
BLAKE2b-256 | c755dc1059988c8d77d2b70fe238b7490d72b87454464e8c220afa63f4cd8304 |