@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.33.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c68e58da748ae6d7ca767e814bebb942a2901db75d0868386ed49254e599bd97 |
|
MD5 | d393327cd9bc4268165de75999e86ffb |
|
BLAKE2b-256 | 89ae55d14827f88b9449a9a8fdefd1172e39013784d1a21c9d6398e74e540cc8 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.33-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd76c1a2e589d21550eb5151b69a8a04a7b0db88308ec85a3e52f60d54a924b2 |
|
MD5 | a15ac7b7738f2b7117c6799cc09d2f87 |
|
BLAKE2b-256 | 349fa502d895fccef3675bf2be678ace770abf523e58b39380ea7b8dc060c0ca |