@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.13.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e3c49d5e6cd3c1a1a9c111a97aaa1dbefcfad0afc18fe25b16289236eea2f9b |
|
MD5 | bceceb52fe90768fc92826b3a965b111 |
|
BLAKE2b-256 | 54fc930f00e67bc2860b5920120dd00d1f78d44ee4fb94c05f43aac74a31969a |
Hashes for aws_prototyping_sdk.pdk_nag-0.13.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6feb05c96bd5a8cbc5906c7e2c97a58fa515d53cb828d748a47c9bf493ceca71 |
|
MD5 | 2eb30a50feedbadbe2f86da0c8df979f |
|
BLAKE2b-256 | fdaa42868bd4821ab1c6c3c79186d2a891da9b5793194839f080a178c8f537fc |