@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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70575aff59814bfb1175975df383c7a3dd06495aeaa1461cceee8901fde8d94e |
|
MD5 | 98963e3845f99b2c2e8022e35c4b8d9e |
|
BLAKE2b-256 | 40b8f41860e537e52ba2eacd129ea3aad7b8cd6fefbce30d788b683fe727cd3b |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4bab8dfd84913da0e2ea086f27c3ebce5cf04d8b9896ee90c6503fd87a8e8e78 |
|
MD5 | 64b53bb21ea7f0b6197663c1e976b7b0 |
|
BLAKE2b-256 | f52edb15c1494e2f3010e99be6bcc812bdbfd1cc274c118b6a17653f7c74de65 |