@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.24.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 991fad361d5aa79f7bf1be723bb16b3dd35f6d7ccb1d6edbcbdcf137bd44ad6c |
|
MD5 | 453fc394dd36cad34e5a8abc7fea754a |
|
BLAKE2b-256 | f2bf13aeaf54dd6241c61b203581ef2e2a7d338d070b4aa27410d4bdf7693ab3 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.24-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1eccef26ec221fbe221d86d94fbdb20377b50a2bd7fdab64e2f886b0a58640e |
|
MD5 | b92e8a4ea9caa9481b641bf63b960689 |
|
BLAKE2b-256 | f17d94f0027712c8608e14653e95f28d80e8aaa75516d8bd0d72ff4d4e5edf33 |