@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.35.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e8dc7bdc05845c38a681c941cb879ea2bce07a5dc16bc6ef27fbe4d14cba7c3 |
|
MD5 | 612390c319212cab1a4574bb1c8c2482 |
|
BLAKE2b-256 | 503d48bbc28d300d492c7c657a81d66b79483cabc668389f96790d5dd3fbe398 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.35-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cc665487cd315e06414283a6260cc62e55c3ada2825af1a6520bce4c23593a4 |
|
MD5 | d3b339ebf3d9f23479d6d4b25e55d17e |
|
BLAKE2b-256 | 027e144d721541220e35f6617e0f248c1dfd64159087ed159c0542a88740334a |