@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.17.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | abe7361ab0cd06848dcc65039ce799434da1f439f10fb8ee75c44ad75598405b |
|
MD5 | 559c74ce73eae44153f3e2e2417fa39c |
|
BLAKE2b-256 | be9ea7aecdb8ed06972781df4c1825275a244b455b675836c519568b2b4ad977 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf5767f399321b4a18f1a8944641dcea00fcaff0870ca9ec443d7367f90b675d |
|
MD5 | e7f15fba8b9af67a1e52484b1ea0ccb4 |
|
BLAKE2b-256 | e784969c0acec03a4b2eee9d5f821982a681617834c4d5833e0a2713f76b28ce |