@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.48.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20af02b3de18d01aefcb2564c773e2ba5c141aecdf1e73b3d48a8e5a029a2972 |
|
MD5 | bb3e6b3de24d69b1f5ada176fefc381e |
|
BLAKE2b-256 | 4ffa1edabd17dd60837b22ad243e94946d2e9bb5f4d243aa9a04a98b41269b91 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.48-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25bb0368fff53dbef5f8f7831f193455c2137831bc7e1c859556af515343f4eb |
|
MD5 | 4c9fb01403868bf4ca964ccfa1b9cdb1 |
|
BLAKE2b-256 | 69172d225a92cbb52883a16d640b1f8e43f781b805e64def68e1d00f15fb010d |