@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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1bfcedbaa50288940b8a46f4a05611e482913438827129c6d47bd4a8fdb598b |
|
MD5 | 19ef71e4904f70e72793951a6646a41f |
|
BLAKE2b-256 | 3340b48f3446cd5de01aeb41f5ba28c0aa68736f7c503d49af54434ee5660beb |
Hashes for aws_prototyping_sdk.pdk_nag-0.13.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca903916b31d950e4674c1557db87591269f6fd8dbe9a8d829180d2cef75c009 |
|
MD5 | 716e062a0c831a7bf69bf668b9e221e3 |
|
BLAKE2b-256 | 8c53c3f11a2306b32a1b305eb2cff6778a4e7bd0c2eb584d935b493cb55f5b21 |