@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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b5b51f8ac6ad70edcc9155b3115b98be14e0863c83cf1aab1164603b8031c0d |
|
MD5 | edfd352f29bf7de527c66009849f1122 |
|
BLAKE2b-256 | 7cd53b5dc91a6c9139cd8a4188ba5c24e33a701bb77f3f31d3415442ef1c0e29 |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 051f524faab9cb9d1a4dfc1c1a5a5eca5f908babebf26e6a2885e5a696e5ad4d |
|
MD5 | 5311571d66fb93d82b72cc8fcd0dd33e |
|
BLAKE2b-256 | c9213deab4761b997cb5c10d1526eca5b73cef5e9d379cda52f3ccb37a4ce7db |