@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.14.20.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7449b4ad39ab24e45f73264c1a8bb72c227f68bbfc390ecfcd6cc95b0639be1 |
|
MD5 | 6027a77d33cd73e0421bc8a43cf42a73 |
|
BLAKE2b-256 | 7af4c936ea223cd897ff60f250af0b869c156cb8157ff743604d6170edd8a00c |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca399aef1af0687ed837be7a7a78b34bf87597e2ccfeca22e7a407b6cf6b7119 |
|
MD5 | cfa51fb0db4076cbd38a6aa80a302861 |
|
BLAKE2b-256 | c095ee433cc99ea5935dc92838e09b03afa5dc4d2651755f51ec2c88b7f4a178 |