@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.17.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8daf0824188f0b840356bdd33635151c3932bd604a507e50fd8a6169d9457bc0 |
|
MD5 | 9b75ce0ec3126cf9fc992c0ba8db1114 |
|
BLAKE2b-256 | 94927d44d9ef444e094849fad9609513b79f2e8a339215ae6b4fca5ecbfee577 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c571f44c841b1db20ba7a51186ae3e65431e846d725d35d6d0d21c894d96cf7 |
|
MD5 | 5d15e0c0309465fcf1c0ce67077b7767 |
|
BLAKE2b-256 | d15fdb407e9c4a29e00ef07653eabf9f722d4f2d911e82bae9507bed4d88167a |