@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.18.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf799f42afde649d7fd16189e87129d3c799b07271e39c106bcd7eded73b20d0 |
|
MD5 | 845c99b4412947fefb566a189f45459f |
|
BLAKE2b-256 | 458f5f943d7c932a0e4fb306e0c69dbaaaa9db8b84726a846c031bcf4f2d9e62 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63fc453011fcfbe7c10a3653087842653cfa7fc409a463159e3c2069f5ef5575 |
|
MD5 | aaa6ac4af49f031ebd41a06816f03344 |
|
BLAKE2b-256 | af2e8759859fd6cccf3a3d1aa19e63bfee39bbc95fcb4fce9ba1f75fc091de5d |