@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.26.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc56922458760c8c04be4de35044fa20e7b9c3df6262794f1d3301b90fb1c4a5 |
|
MD5 | ff3d5f96053a82a55a6361722bbac326 |
|
BLAKE2b-256 | 9645e7f5b3bea2d4df1d286e4795663d4c604ffa863a228cb37cdb4057d136dc |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.26-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a624b9f2027592189729dda20135212a6819029bfd1b3cb442893c3091f11e46 |
|
MD5 | b540d435e9531404d1af27f56b603254 |
|
BLAKE2b-256 | b468bacc9adfe250eb991b8b46de1df2c5025063c88b402ddd125e69566a97a6 |