@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.17.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93c3a0084f34be85de0e4fe162a06a7d10749fb4931bd1db2b88625f3fd9f222 |
|
MD5 | f36fed7fff35c1a6c3efa00989cd1fe5 |
|
BLAKE2b-256 | 42cac0afec313d3947cf65432278ca04f6e5ddc4417caf77765958399b198df3 |
Hashes for aws_prototyping_sdk.pdk_nag-0.17.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f3ad7393e9ab0e727cd43a725aeed7e8d79df4772764195e441074d19d5e86b |
|
MD5 | 64612a1416357edbfa2b9d80e052fb2f |
|
BLAKE2b-256 | b2f280c5a781797943bbfa2e516a07d09e4b36c164f2fc8867de6f4f0e518276 |