@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.12.33.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c111524493e01992620aecc4dba5b26ed909cbae29c7df23a71660aae631176b |
|
MD5 | c9679ade24bc5be6c1a5b30d6a1f15dc |
|
BLAKE2b-256 | 9a7544c701a299056bba2dd91bc169ad4b99bee09a6da5d176825bac3476d32d |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.33-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f0544f967eb81c722b74a69bf9e59bb836417883e8b4e992ee7a0ed6f4c4cfe |
|
MD5 | 4497418fde65fef7bf15fe069eea7148 |
|
BLAKE2b-256 | c311f0ce29ed80efa340cac596d5e00f0584567cd2b4a4900a1b8fddd42f7fde |