@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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e0a12b420335f70cdc146078b1f3e76acd6e479a9411c44c30d2451fe4ce10a |
|
MD5 | 192643cb9dafd01d046d4b69978ac963 |
|
BLAKE2b-256 | 5ec33f35b94a7ecdbd90d8ed2dd21f0c344820f6584df9179af0525fe00010e5 |
Hashes for aws_prototyping_sdk.pdk_nag-0.17.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dcb4315ebaf98d10c91e47a6b41c4db05819f0c9829ead242c9c08923d42d9a4 |
|
MD5 | b59ae5476c920ecd90bd2c01207ad0e1 |
|
BLAKE2b-256 | 1996d5226745b11356b6d20949c8c01c6b8963544d743270649c8b080d16d0b9 |