@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.36.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45883d887a50ad88dc9699abd0b2e7842abc042234b7402f9bb6dff2da8a47d6 |
|
MD5 | c459535521942b74fa0494b77dcfd876 |
|
BLAKE2b-256 | 92d54acd28cdee97a52ab8edcaeaf05a1bc90e26eca06e4faa814a9ac3a76187 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.36-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11a16f147708680184b59bb721a0eb34c2ba13d3f72655bcac84bc175ae15011 |
|
MD5 | 4784aa6d92f2e82d99988fd3d37bc53b |
|
BLAKE2b-256 | 5686ba050cb172c1dd90b2c41053a122f3ae5dd9927ccaf98f9e22d22769452f |