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;
1 maintainer
Metadata
1 maintainer
Release files for aws-prototyping-sdk.pdk-nag 0.19.68
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aws_prototyping_sdk.pdk_nag-0.19.68.tar.gz | 98.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aws_prototyping_sdk.pdk_nag-0.19.68-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 194.7 kB
Release files / aws_prototyping_sdk.pdk_nag-0.19.68.tar.gz
| Download URL | aws_prototyping_sdk.pdk_nag-0.19.68.tar.gz |
|---|---|
| Size | 98.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fb12fba266a38d8c877425f6b3ae20f60117982c6c06c636e1b606be8fcbccaa
|
|
BLAKE2b-256 checksum How to use checksums |
591846560368a8d9a8d1306f4e321a35da4b829005c47b10c8db83a23158381f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / aws_prototyping_sdk.pdk_nag-0.19.68-py3-none-any.whl
| Download URL | aws_prototyping_sdk.pdk_nag-0.19.68-py3-none-any.whl |
|---|---|
| Size | 96.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5f976b3e86b8e0424078ea2c367e09aaf009ca82465a6de3e106513b00e6f252
|
|
BLAKE2b-256 checksum How to use checksums |
c99c7ec0b475be54650cb1328ab762d7a47cc1af54770d696f484c31bfb354f0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
