@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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39dbe610e15b004615cb1a6ab579e78bec4c158ab24ca85874f685897de01bdd |
|
MD5 | e1801c2d75d5a8a91d4bf0b090ab1c6b |
|
BLAKE2b-256 | cbdb1df5a6556d1b6bc6a4275f98b15fdb45b4a9d2d32731e9795cbbe96efd21 |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a21735b67d943526ca961e8111fd9a5b92e251e0eb0cb110392db5a1955f7cbd |
|
MD5 | 433fb7040a72540ba5f584ec859b3549 |
|
BLAKE2b-256 | 76be05042db33542448d58e7d5eb5d1b291872db883f36939c7d6319a0671a79 |