@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.63.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9124befbc2f7abf7d0a8e1cc4d3167b4bc0e0b829a361e382e4743c86e0fde3 |
|
MD5 | 819bf692e5cf4b048a14bbd0bf922b32 |
|
BLAKE2b-256 | 1c3dfa332bd5623159473dd21dab746edca82aa4457a32dafde4ac3f16534903 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.63-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6221c1a56364560d40279620cdecb0092c649ab0ef91c84acab9ccbe72541bd6 |
|
MD5 | cd70c5033b81ce9db47be8b94fad1ead |
|
BLAKE2b-256 | e28b8cfa19b7107c9013ea19f31f7c54fcc505e8383a96b5e893a0f161924ab3 |