@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.38.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93eb962667becf4bfa73100e98229d68c55d9c1ee1aa333dec18b0a47e7f1cd9 |
|
MD5 | b789fda1fd0fa2fbe155bf566df66fe6 |
|
BLAKE2b-256 | 7cdf916d16d8b5d18b36029a5e30f3c5a6381b79cc87023b5aee9eeb715a8fe2 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.38-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 910ea0140757362499b724bf8ae78dd8541289aa4c12dc736d88cc838b7809e4 |
|
MD5 | 4aa2c2b358d89c9d3f2da2487819dda7 |
|
BLAKE2b-256 | 709b9e3ebcf80d042393f0a7c21bd13c78918f783a5d8b57e966a672a5f4c404 |