@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.56.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c57717d76f552508b126d4a81cd90a8a7b63b5a615df36e7ef8257d3b6caa7fd |
|
MD5 | cdc01d352eefa6a793a5e6d387ab195a |
|
BLAKE2b-256 | f6a1e9e01f3b63225323a159b8039970f54e0157ad7e1c24177555c9236fef95 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.56-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 438740a0997582896e864fae84565a56e2bc70c8f84cd007835216d87eb4b7ae |
|
MD5 | 9bc6924f8b2c4f01e5f61998a07619af |
|
BLAKE2b-256 | d6abbda8830c68fb37792bc6c6b4742df8cc4e2a870684d6fa75f6aae2ccadfc |