@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.18.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f427ca0da46a92e22691a2b2d910882a6bc8a84572831e9a7aaceadb2e900942 |
|
MD5 | 73742d4f6012da2cb8a07836ffd35a49 |
|
BLAKE2b-256 | df1d5754da8bbda0baf57029d2c26a898ee090b4cd4ab4051cd4927986baaeed |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47ad329e6a2aeac703a8b18492ebe4508dee4ecda18c2d154814f97e9d4e2ff1 |
|
MD5 | e0b4f6f9213ae4dd95fcd5f3a180ab29 |
|
BLAKE2b-256 | 046ef237b3ac52b09dcca4177b32dc376e3a30059f5cb42cb432e32af1499931 |