@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.62.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 873320495a58bb28387751b96e46dc2ae46f76031c34c41318926dc7bd3efe0f |
|
MD5 | 08de8dd634fa25bf96fbccd8f25b8917 |
|
BLAKE2b-256 | e6e57c9ea9a4a3adb820cc31a0f97ff754e0841bbbed1819add4462a12dbe4b6 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.62-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78e181324e355c60a04eda41165db0d90acce6829acf065f715f634b8e08b6c7 |
|
MD5 | 0aa449eae454b89413f2ead797768ad9 |
|
BLAKE2b-256 | ca696e8f380438fec5e00d435d82684ae31db8cc681f1ce64f92d6f3a1c48b2c |