@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.17.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44aa60c6f44ebe8563af51f0abad9c6a3c1965680950b4224c0ab26ebaa1bfb5 |
|
MD5 | f5aa5d9f8f8376d33bbbb526f17184a3 |
|
BLAKE2b-256 | 53104fe9bcf8648fffd8f68746f4c27163f8ca65bad896e2ec06b26b33f87cb0 |
Hashes for aws_prototyping_sdk.pdk_nag-0.17.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc9c58c584bc64388d8ef82e808d2c488ddf86a6535ab361a9a03b2d92c50f4b |
|
MD5 | ba48a9fcd23d249a6cc0785b6281f998 |
|
BLAKE2b-256 | b478629a33e0612a15f14491c865eb1d2ba973a5a9a7ca8e4afaf43863645516 |