@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.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 802cdbe26115853b303b3e29277450e31f72f36621b95a9b2cc94929a768d65f |
|
MD5 | b19219a831b01fe2c212ddc0bab3724d |
|
BLAKE2b-256 | 893775be0a8d31cb5594330752e2d7ca3f7ae3e5ba119044be566964304ca767 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7c2fe1c58a3954d8d69946b769621f9ba1499e5bdfa57b7a571b9dc16a77a9f |
|
MD5 | ceb3560f9254178f7a24dd477b234c39 |
|
BLAKE2b-256 | 0c20526d84a35c2705501e2189931a5238f4149202708e4b7091fd7889c95520 |