@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.14.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38d983d4b32df53ddfcde26e5e34690a0834e4ba741e1f32188140f17e708304 |
|
MD5 | 998ed3084067f4a7970febf0f724df86 |
|
BLAKE2b-256 | 96ba148eb5bf283b5aef4fb355e0a2c6d37099c83d5f73ebfd2b120de701288c |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7297792859d29fcd8c63162460c139b18e7170a48051228b9f8fc1912c43806 |
|
MD5 | c72b0dd68a4f70891cc2cefc20352ffc |
|
BLAKE2b-256 | 6e96cfed413fc9d505a55f633c94d72d2e18b0764933071101a93a15e2b90e1f |