@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.15.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c851c0b2032b4582d970b7fa8b146e91f3b7bc9c36e05e15bf3ac3eb20255906 |
|
MD5 | 796b3ce76ad08d95e203dd1cc227e0cf |
|
BLAKE2b-256 | 0bef694dac8957fd8df514fcbfa12c92849fa80bf6afb30013fd0a1da51a20bc |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d81e3aec8858aae66cf16fb047e0c3127a4f775d7a39096f481d22afc207800 |
|
MD5 | a982b36514c0a54faa088220528175f7 |
|
BLAKE2b-256 | a6647b736c8265513811db884e488a0b64541fa2c2b0dc646f542bc177732c3c |