@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.28.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb22f3e6539715dfdba87bf5f2c9834c95fd9f1dfd90b4d56b10dd8395608bf1 |
|
MD5 | 409a5f7351ee51ac4ad4f735c6e72d3e |
|
BLAKE2b-256 | b944b6d736e25ced866b4aad6af685d56d391b63fa1f67ac5ec8034606f03991 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.28-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 219fbd9468c74377057f1fa714995f518791d26600e1b3aa796428c430058acb |
|
MD5 | 0c739d26f233ff495f6a89d5a962013d |
|
BLAKE2b-256 | 6571f86512dcbd2f7c8ff5c68383d2f3903f1c376d7802d0309f51bf4d78e2ea |