@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.18.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdf8a824b4b4ee092947b2a661d9ea90f012dea61baa59cb1e486de6e378efa4 |
|
MD5 | 3f5f6dcbb00a7969c537d617f3116d34 |
|
BLAKE2b-256 | 777814b74cd17baf710b16622525da574cf5d6ba9ab4990856b695d89c92af19 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fd4d8008b2c294e1ba5e4ff8dd5fb3ce2b0db350aa4c58975aa00242cf2d58c |
|
MD5 | 019ebc518bd6f56b3bbb5511d21aa2fe |
|
BLAKE2b-256 | c6bd939eb93a8752fc974735e2d515148e379e6ccef126ae2f43b2f7ec50620e |