@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.30.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3aec1282f8a7db4aee1ee66fbb8ed2be8974f8755ad27c63ff1fbe665978a6b2 |
|
MD5 | cf18a2ca217007711a43b17996d6a880 |
|
BLAKE2b-256 | 8f367e545e0aeac437d5952c3c81c4fbfe696c51912266a76a0ab0a781613214 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.30-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1044f3aa7fd954f3acd5185dcbf448bce1d2b686a20a7f1e5fdca4ea1136ee59 |
|
MD5 | feca3a0592ef0aaab58bfd20ebde93f2 |
|
BLAKE2b-256 | 56bf5ef6f5d5b656fd9175e27cf65e89c4b852b61e1f082924e225f7a6fdadbd |