@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.14.17.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6fcb7b4aadfe20a03ab61e9da2241cbc2bef4d0de1618f0c1a746ab62fa2bbd |
|
MD5 | 2827c945c0751abcc1f2d9c971d08fd0 |
|
BLAKE2b-256 | 26e4ee12ce575dcf71fc69aad8742a20440dc2b1ededfa182c23b546fbbccc4b |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d2bf84001e59eb173b2fef4d76d6dd5cda33fb61caa8209f06eed7ac09bbe63 |
|
MD5 | 3a9b88ff6734e6b5557aea38f348788b |
|
BLAKE2b-256 | 7187680edc0e2d1d652ec209704804b6c096f286c0ad52e0fb856ec3c6e7c050 |