@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.25.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 924dcfda00a346079ccad7c1d63a7ebe9291c91e7df641f7e90d0a2917a4c4c9 |
|
MD5 | dda86ea72a586bf1af49734dd640ffc2 |
|
BLAKE2b-256 | 72ba50adf1a77a89c102cc59b339d1b2c05179cdf639ed2692d6c1fb13d8deb7 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.25-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdc54373b1f9c8239ce61b444bcabd78f8dad3bff941243ab4ab309381f02d0e |
|
MD5 | 52347a2158112ece87cebb4635e312c9 |
|
BLAKE2b-256 | 397f32fd248c0cf3ca01b323c1b85c3540fac4be469ba3e602f62dcd806535d4 |