@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.37.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48c93fcc90c295a11d47af6aa6eb763a387c54178ff201c7c31c8a21ce1656e5 |
|
MD5 | e71b425b5eb402acea41a7cffae60c91 |
|
BLAKE2b-256 | a6d9c4ff8f6d2c1602297a70360af037052f819b1183534d9f6465f71d4ac384 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.37-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd695c51497f97732d2bbc7a58c7956423fc8175b8990659eb2085b0079f5eb8 |
|
MD5 | 517bd735a9804b16f4362e9e402c05f1 |
|
BLAKE2b-256 | ef60cc56be1dbf3b66e4a9005e853739477ea1d59000c6da36d3eb506e85d91a |