@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.25.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f47611ddd00a3fb93edb6ed6dbb778b039467daa2773d5181ce9d241ae162bbb |
|
MD5 | 029de98c3298bf5446bc5ab32715d6fa |
|
BLAKE2b-256 | c82b9e05a3e55207fe9f0c2c070d45642020baef3acc9098d2f69d9433769c5a |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.25-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0db46655e627a146cce38dc19b73d21ba185569ba0c8ebf618579bdb27c5bd3 |
|
MD5 | b8596e3c7cb16e9ea15d141a114bc74a |
|
BLAKE2b-256 | e6b91af27fcf9d866e0715c62e8c2d012ed8da90af41f640bc9410b6a892369d |