@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.14.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7cadd9529e6d91df9ce795f79964fce9e72c570c09336224c155e3282fe21cab |
|
MD5 | d17f191ed7b9ab867a9a6cf0401b5c80 |
|
BLAKE2b-256 | 65cba92899f5a2b643c2c3c911a1598f4eddbd756f98703846e7323d2f3e177b |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 464cb888d9b116915fe550b220997c1f170ff9728eed357083ce5e7993b8bf67 |
|
MD5 | 0510519c0ee25f2d5117d897e9e3ab2b |
|
BLAKE2b-256 | deaffdb7ac6ffb220b84ec9721a1a7b748057f7c2691e9f2e48cdf162ab79fea |