@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.18.17.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9b60c9c6f673eb536f81c4645fce153359b808b98f4ab01ed6032b2cdb38fd5 |
|
MD5 | 3d82a21017938dd6eb3a75529db57e28 |
|
BLAKE2b-256 | bdcad43f294c3d0ee9c55837f0e04dc221f003fb52ef7f04d936a5db0f48892e |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c17160d0a7b9a8bcabf5ae44325d53b7c123b086e560acde4a7c1de8d2ad173 |
|
MD5 | 2b58970e579d8966d854e1be7e91d2e6 |
|
BLAKE2b-256 | 87d11f5a79b84578d114a619639265971ce460a6a35149a3c1345e5f97e49307 |