@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.34.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b541fc43b89580bd43ff785b6a3e344d9cf34062c5bc9f058e35704c92542eb2 |
|
MD5 | d74faeb6a49442301f244c72eadcd68c |
|
BLAKE2b-256 | a5b4f0084ace6ca8dd078c9808c0e403d616b35bc204c0c656fefc3554d8b610 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.34-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb456e36aa4bfd8c6f2684fe4b17ab1047ce63ebe5897ea73722c09f4be971ec |
|
MD5 | 8860ebca382e7a7810b66af103a5fe01 |
|
BLAKE2b-256 | 3ec2db434555f519dec92d2c840855d8f686c29525fa2793d5a35ec674f5b5c7 |