@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.19.64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0fa22dc7a1909de5f283ce664a4f5cabb83da13d98deef1858af326760639ff |
|
MD5 | aae34ec366d208b68f891ae478c5bc42 |
|
BLAKE2b-256 | a40be90df2aaa5de1c52057d5bacb995b3beeb8c4c264ca11b69114cc9cd7c15 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.64-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7aef4f9cdef12ec866c580afeb8fefb926e80aa9b85fa1b5e581ce57c89d6684 |
|
MD5 | f82257868f4954cb43ec730c984128e0 |
|
BLAKE2b-256 | 62939725d538214b53a512f0663b0d76ab0acb1040b2f6960bd2f2c8b67f821e |