@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.18.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85a8159cd36f688c7a25d032d46a6cbc36a2fd112f737bff66ef87b05b5b6a26 |
|
MD5 | 624df9feb7fb4885bb1eb40343964bf5 |
|
BLAKE2b-256 | 8a802531ac95daba249795122bbb6094a386dd8e02d6f0f50c0a2f0977019eea |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 308ae29006751d569bdeb26e2fa5358d99d8de9d75b2bca9d6286b055e0f0596 |
|
MD5 | abd394023f131a3888c03dc1dd29c84c |
|
BLAKE2b-256 | 33ddc30e8fbffa34f541f3f2fe10cd4d34a084e9cc0a9650b787b7e3adea30cc |