@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.17.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18ef9f4ba822425a9559ce7bbbee9b7e5e5ba13f018de703fa7473a4cbfee426 |
|
MD5 | 6d20dc19364354104c274607a9712256 |
|
BLAKE2b-256 | ba401e26d1d31e944c7590d95d2bba107001490978995ee11658aeaaef70e1dd |
Hashes for aws_prototyping_sdk.pdk_nag-0.17.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9807b972606beb306d4e5d51e5b9883ce2a3b64b9b1a4d765498bbaecec8a41f |
|
MD5 | dc7cadd618ca0cccc77fc3dca74dd4a5 |
|
BLAKE2b-256 | 7735ce8fbc8e7886dee3a61790409d187ea78e2757cf1fa9a8315a4919822436 |