@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.51.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09ac5692ca24438db752c7b4244f9bb6e2a253db7ebdce164d1095e74def4555 |
|
MD5 | aa0890731315fe63061b7007cb8af880 |
|
BLAKE2b-256 | 5ad85789986b3a9d91aa63852249c6147931a2c2877e4828d10ba3b3750c7ec4 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.51-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94d8789db6d18a1344404831c2a6468537d606de0dc2c1098edce5f51e4a0d0a |
|
MD5 | 169c12defbb04ce4d38609632c110bbe |
|
BLAKE2b-256 | 068aa1dc19470b2cccda9819c23375b94ec42ed1815704bb6a542d7d9649b16e |