@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.13.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 75eccb3bba06e5434c623e130a833829a80d513b57d0619497e749132985d573 |
|
MD5 | cf2d45f42d81c094b441f1fc5b4bc0f2 |
|
BLAKE2b-256 | 850a3d68b07c6f724787eb020af07aa7f753b93d2086d38d558e4d3a0ebba0e1 |
Hashes for aws_prototyping_sdk.pdk_nag-0.13.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba16c7a7d87b4b718409ed6f564c8ac5f8abf19f097ed28d07c1ed9acb07744a |
|
MD5 | ae773bf5848cf8905d4e5f26efe52981 |
|
BLAKE2b-256 | a5a5e99db80e20d6a522e450005bb1bb82a5efe7048b4e6f5d8c48c4629aacdc |