@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.31.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a73d6be358916347c5b908d584a63bf23e21bd95d1e36f8451c833ece33934d6 |
|
MD5 | 7e8243e2082191f0121c2db12da521e4 |
|
BLAKE2b-256 | 0c21d5e775b64cb6aef5d011e7270388c05d83938abcfa109908264fb7dde83f |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.31-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 148f78b25997732562fbfa1562f1138bdc7d013c8e494c2e4018a86b59bf9987 |
|
MD5 | 6776bd58bb6f4b4b31758fa12bc1e1c8 |
|
BLAKE2b-256 | bbaf605d0a8df2d968dacebdb7bf7fba5ca6ca73bf528087e75632d8c8e195e2 |