@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.18.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18eb877a2ddff1fdb40d17e93c8426332b53cd144eda64ac6045541604dec6f8 |
|
MD5 | fdb898c05f051c8ad8364c3621132b2c |
|
BLAKE2b-256 | d45cb9ae8fbe8acfc9521a14e56675ac1d9f5f0a5a74803914ba550385644c27 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e35147427cfabe57225737391432fc9cee9a652c4fa05c17dc8cf6a5e1ddb40b |
|
MD5 | 48db49d69f995faf3a166594b91fb6a2 |
|
BLAKE2b-256 | eae451a9a440061d942bf413f1f2693c5752a23cd937bccb684eba7d81a734dd |