@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.37.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | de7967ab9d818a3978cbd2176cbc80067b7cfb353cab3bd62ae0387de2726591 |
|
MD5 | 8c84ec5101b2c3a84016f98d3627b9c3 |
|
BLAKE2b-256 | 499ea17d84aba96dee0b62c79c9c770380d648b93356b9da7b01b4c867badc31 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.37-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a623ef3dc9648950dbb534e77d2a7ac70102446997f3eaac4b03f21ad7baed0 |
|
MD5 | 802cf12ce39986d7b2ac87bd18e24b9b |
|
BLAKE2b-256 | df8e7185e88a2330e6c82f0fbc2d85cd22d621093504a6392d144cbd246ec850 |