@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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b220ac473a5408c878139441adace46e6cb5d6a66a10f923d210a869ad1c00da |
|
MD5 | 7998c9451f5cc869d2dbf86deaf02931 |
|
BLAKE2b-256 | 9426f10e6b5a8121d8658047e09810faca0754b6953f54730f43f143025986b3 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54b057f19497400ae0e426c8c08308224c8086350888e3645c6b8aaf39b6da74 |
|
MD5 | 212fbf6625c0229f0b9aa730f911afa6 |
|
BLAKE2b-256 | ddbb903be30f360d07782c5ef3fa8b6cb524aec64b6006ee20f279bc9dd46c11 |