@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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23ab9af31e2f4ad85a83ea5bb7b0daa4d85e95f79275c5472df25edb57d0a88d |
|
MD5 | bd61b5d8b9e23a3b475b50413b9e44ed |
|
BLAKE2b-256 | 6c08ba38d3258d988b4b22696b12d5c220ac50bb33aa499655b6e444edf55f01 |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a439ef5a4eb4fb42f550dee956ac3bec945da4858e63c93022afcf64a5295abc |
|
MD5 | e7f8adf09e5edc1418d01169ee8d2ff5 |
|
BLAKE2b-256 | d2e9452d5d4ac62a8a9ac98366389b2af0001735cfc556ba8eec98969e6e636c |