@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.50.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0591e03d99bdaf4bc62d639e96bacfc5127ad9d7b1be9dbd492b42d87d842ef4 |
|
MD5 | 86bd12bce6e08912eb981ee0a775daac |
|
BLAKE2b-256 | 910c5c7227dae43d58ea3f59fcaa2524254f8446736860785983f5a4fe7136d3 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.50-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83401eac27e3193658d9e78915ef4fd218ef5c6823a808ab2c9f132aac6facc0 |
|
MD5 | 1e9a90c69dd07bdb4e3fa605b19e82da |
|
BLAKE2b-256 | 2dfad3dae855cbdfe57cb44199b1c796f554883d1d4b160dc0abf806ddc3d451 |