@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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc54e8958a3a78fcf02ac93b60c9a43da3cfc3224dabb719005bf5434449810e |
|
MD5 | cd8c55ccdec86328b62c28108327a639 |
|
BLAKE2b-256 | 6bb007bfba93c0bf3203fbcf95d94d00fd82d5e7c59e7cf78bf6a4b2aa0ddd26 |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc738c0ffeb82583439a946a42afe73f9ea20ea21f033b1eb9a63bea6d6937d1 |
|
MD5 | 523dfba8ee508ebadc055b04c6270078 |
|
BLAKE2b-256 | bd16cd668812a6792682a5d454e7ddff198efaae9b4756b4c8c340da99c5f6cd |