@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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41f593af6c33b54747eb2716d70534fd9d6546f236d1a3d5d33f4509c3a56201 |
|
MD5 | 7730243327800f9c1c315b2bd509b339 |
|
BLAKE2b-256 | 8289de4904fdf8fa570887a5353695e565845f45c9837f83b003ec74d9527d3c |
Hashes for aws_prototyping_sdk.pdk_nag-0.13.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7dd0d05513bd505d582ed6b4a6fd6afba665d5963815e8b493689a2ce94b9a2f |
|
MD5 | 859ca8308ac7bbe7795da0951e0bfa18 |
|
BLAKE2b-256 | 38733dd0d5632f17512ea56e9beb5e95df53a821b6d3e3ffacb8841e4d6536f1 |