@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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84f856cde1a33d002d838f80f5886b80d962d4f5cefbef139759a09f2a86233f |
|
MD5 | 1b513aa7d2c01ac089fb598eabc8e2b9 |
|
BLAKE2b-256 | 85e77e81dd66fd932e4d5be2dd5ae12e072730ee73aae63a9db838f20d1b8c02 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f7c826202dd5d69a60964577245d08d853aea5eb86e08033fdc13988c26a228 |
|
MD5 | 83a61ce702e13530a134ceb9c5c31e2c |
|
BLAKE2b-256 | 0cb0bfbaf5a46c2218c12d3d8ced8528b64e5f5495605aa4d59b91611dddf820 |