@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.12.32.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c3d209d6b23cd833cca634abfb78123ae969f3993ccbe026ba9bb6b1da3b9df |
|
MD5 | ed5536bf36dc4f8149335043742cc015 |
|
BLAKE2b-256 | bd771686fbd94592f37a5dde3e618d385fc5293018305dc753fe4e3e1fe56344 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.32-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fd7f7c3461feb465b093b1207b89c677515dcc18bc059bbcb59803a24ee28c7 |
|
MD5 | 5bd01deb567b6aa9fd8a72c06d4a2e80 |
|
BLAKE2b-256 | 4ea0a3e575f94aa9aef26f63360e11dd4e56173f0bcd9c2a4c88ec43d73b0866 |