@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.55.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4777a0831fa23980d10968fc5bcbcbeae8fe0f927e49c5c149914e3c0e3f1c3e |
|
MD5 | be522381b7c2cba4ea1b757dc3903734 |
|
BLAKE2b-256 | 6e786b7945643e4ee7f628e440269af2a7d931471ba97279e472b51ae8d25122 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.55-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b07612c62f2fc6415c1c8c53013b145e6c2dc3ad7cbfe7379d99bdae2fe0568e |
|
MD5 | f4ea37570a62d1b110faa44b527716cd |
|
BLAKE2b-256 | be2e52287557364b46d04eb51c1389ee282e896d818e774abc3efa0eee78d5ef |