@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.22.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf832c731c6dc6dde050cd8bddc1742b5eace390f0019d89bbb09c977769b1f5 |
|
MD5 | df2c50c670e22b088dd18d595d31aa7a |
|
BLAKE2b-256 | 4e12ff32c118591d9424c70c9f71304e4a41675490346ef82c26bd8c83e7b9b9 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.22-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9d5fda89425871670bb9ce8de8a230f7092f84b309654c91a3de471f77a7810 |
|
MD5 | b71b1f9abea3b48540c1a1dcc6d7e5be |
|
BLAKE2b-256 | 0ca8c523be41d0c90828fff8f80341b042de015c683c2ed4a902430d13f91fce |