@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.53.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e48af500e03b919e0c22aec21381353a3d68e69555e89b03839f71e14529bcac |
|
MD5 | 2aa3f215c55c2acb9e1022d3ecdb3c14 |
|
BLAKE2b-256 | f98b9e624160009027b86e8450cce9bb5b79e38aafe8844d9a41d35ecc837ceb |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.53-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9678cc6b13211def6edd056830fe2036f679bf4b17732323b4b61a16810df734 |
|
MD5 | 146fe279f8405b841c94dbdb53f0f4ff |
|
BLAKE2b-256 | ea5a8aa0ad1b5f5d7bae126fe7590ff3596c5003ffe2d6f09a4c610647480880 |