@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.36.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2866fee42b28c70c81851b92fefa9eba53876939a5d1e26ee4f9ec51b1296b19 |
|
MD5 | acae5bafa49b0f1871992bef9547fc6d |
|
BLAKE2b-256 | 6e15da5f53ed826d08f61050d246ed0a75c7f41b4299dad80ec63d52c64ccca9 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.36-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b16da496b16e65358056502762a64857b85d2342bdfa3ce26b14fca9b5af3f49 |
|
MD5 | 642858f3734d6085382adc9bdfbabe7b |
|
BLAKE2b-256 | ecac4214f754d58e3f2641f7797963d55a5b2c99f4280f13ae35670c5d2f1874 |