@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.20.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f2ab110937f542ba6aef4bca7ebf3f48d9696e0957e7260f63965dc5841f590 |
|
MD5 | fb44fe24f957927893904737b18f85fe |
|
BLAKE2b-256 | 0acc8898c593e94be3d471f4a2e4b35a287fa38da8baf7a267f6eeca7e780747 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eef378797da8a4cf4947565daffe4d4b246305af6f92fd912f7a1ec6654e2163 |
|
MD5 | 203b1df895f7074c13be1a760a5f501e |
|
BLAKE2b-256 | 93d529e4e01940e5c0c2681c33b41f0ccf275262f28ec2238a2cdee5103ec689 |