@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.42.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b20b325fbb89e68425d47ed4bd678885a42b0d2a6442185eecffcf3e6e8a646 |
|
MD5 | 834e52a989b5f66d6fcfe7e215888676 |
|
BLAKE2b-256 | 196844aa55c4cbc05f653e425d3aa9262176f8a2d4cbfc190a8712619693fef3 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.42-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e48865fa09ca004379ad0fd85876053ebaa836b5631ffb4c5890c2afdba2497f |
|
MD5 | c696f8521bb6dc819ccad3ae6e716567 |
|
BLAKE2b-256 | 88f0371e0488803a4e58a4998b5fd53475d154dc384b3d35ba2896dd8c706c50 |