@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.31.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfa6236a3a4a1f6524e505af3230d09caffc4019f60900d4076f411f85e790c5 |
|
MD5 | 014e8d6082237c19586578088e6f0131 |
|
BLAKE2b-256 | 3e602d335e9574e969709943577c7999b00916d366d514ef93213d673bb4cc95 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.31-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b86b83146b0fa92f5c58153ca993375a2f805f0f83e51810bf98b02e7249499d |
|
MD5 | 8bbdd93cdaf0908ece27a46461c7c2cc |
|
BLAKE2b-256 | a00b72f9392163c33e93064c4b4ba6485e27974f9f751057f021048072a88ba3 |