@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.54.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa1b16f7a68e1989dc04722b41cc63fb9b62d6d63f31734b7170eadc2eb86192 |
|
MD5 | 57be357e2cb9e391c2635a01583fb2b3 |
|
BLAKE2b-256 | 2e514a2816311127e6c1c15d693f2f21df8eaa9d341686fa1b5e4d66ae5138e4 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.54-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba956a4acbf54ecec845d1c30863569c54e5b4b636d772e1af2488c4220a15ea |
|
MD5 | 6bafa990780f81ced7ce87decf5b951a |
|
BLAKE2b-256 | f5f48d6b102a7f6f5db590435730c96d1c8f7abd7bed06287df7128dd45adaa9 |