@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.61.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab791aadea76364e6f61204389e7af16b3dc142df7ed562e0b5ab5f6ab508b89 |
|
MD5 | a2bb3060c15b85d8c25824474bd67207 |
|
BLAKE2b-256 | b13610a5ab66d4bc4a28b5c786f65f1e8051adc6a2a6efe2ecf0e3ef8352ce52 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.61-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 736f8e27e0cb4f5639833b8dcf2bd29c836384080879a188aad5844acf25388e |
|
MD5 | b8706f286bd9aacca416ba8b8865e447 |
|
BLAKE2b-256 | 781ed22cc89074912de20f2c408ccd91d1395b1fca2d72e6d2e6d21ea51d3a17 |