@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.18.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 611f016f393bc4ab22e5675bb8b7cf003ebc32d82b372d7b85906db6a359f0dd |
|
MD5 | 7fca34e37226f759b558f5ef89a4b632 |
|
BLAKE2b-256 | 2947d3ec95e830c0a0a037aaafd5b08edf6384d7ea190bb5e7037a3a0f14471d |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18107337764ed7b1b71bd29a8d706184718ed584230bf30974e8a3d839f3ae2b |
|
MD5 | 807d841d48f9dff94dce413eaeb8b4be |
|
BLAKE2b-256 | f622f4cf0167439b4dad4ba3f773c4f585e691253a56093226b4230c9a0c86cc |