@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.15.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1eddde86b2531782e78d7145b79666f630b7fe1ac61c4722c5e492ec05daffe |
|
MD5 | 28d02f8eadbd50bfab206de56dfae9fd |
|
BLAKE2b-256 | fb1b2a831f4348bb22f6a803abc1f32efbabbef11c9a1936ff842176462fc84e |
Hashes for aws_prototyping_sdk.pdk_nag-0.15.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa50e2cdee625e781c2133c9faf2863efab1c44325e49dada16776f72bb78c54 |
|
MD5 | 9e691d3bdda0183b73206eb3f6f167b8 |
|
BLAKE2b-256 | 1275445c682df738017fbf061a0ccff7b47676f53ed9a7c06fb4480bbe2c341a |