@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.68.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb12fba266a38d8c877425f6b3ae20f60117982c6c06c636e1b606be8fcbccaa |
|
MD5 | 357090b75126ea80f328e5afb6c8dfdd |
|
BLAKE2b-256 | 591846560368a8d9a8d1306f4e321a35da4b829005c47b10c8db83a23158381f |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.68-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f976b3e86b8e0424078ea2c367e09aaf009ca82465a6de3e106513b00e6f252 |
|
MD5 | 392ee5e0becc31617f4d7006742351fc |
|
BLAKE2b-256 | c99c7ec0b475be54650cb1328ab762d7a47cc1af54770d696f484c31bfb354f0 |