@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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82edf0e245f8e1aedc8d402a073dbaa9f7ec019c112559df1472ca66c731b31c |
|
MD5 | 5604023172748972f8d2730360485439 |
|
BLAKE2b-256 | 81ed8ebce9b3a5ee04db97dd9cc005b99b5827c410dd8f686117be9c82357b37 |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ffa8c12e50268c4c7bed07cca5aa17a21ec22054403f1cd71420b050fb92e68 |
|
MD5 | 48d38dd5a15a4ed301d947880cd8cebb |
|
BLAKE2b-256 | c0ab5421b26c453d6fc9416e1340008cb10c68b3546d00ec615c32a5759c6c44 |