@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.27.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e925384f583c463240cce9d82576a7e3a83f071ca07c549a1b15be443a6c43d7 |
|
MD5 | 4cf53ee435662070695ac7533e14ec38 |
|
BLAKE2b-256 | cdf97d44ebd989de248ce659061ea9beb2cd4871cb766c55599a3c4900eb4912 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.27-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9322efb5942bcdc7dcba2d60a9c4cca0229a5ce07b576edd910313b1e8762726 |
|
MD5 | 7d784f8b2fc850aac2b4d36a803bd504 |
|
BLAKE2b-256 | 1e8c5dc266c5e5772701822429a61775175f92d4e5e8befc1b289138456e9e5b |