@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.18.14.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29cf3affc9c3e47b0e7b67ea327e9082d3b3cbe8864a06bc2a5323cbf9d861de |
|
MD5 | d6cfb66af11ef1a657b64884b82b4a87 |
|
BLAKE2b-256 | 8058bb9b3691f5cdd59b8d204f04e7c26b99ab7db8a7970d2e581e84d7d6b3f0 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4d1e308417c3266eec21f5ca1b346d133175bad461089e05c640bf9e64e644a |
|
MD5 | 6409b49724e2fa74f9c474cab5762220 |
|
BLAKE2b-256 | e806854c971c744d30f76be448b024bd71f46c2875f2bf900d0d9ff923aaeea0 |