@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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65955ddf3bd5032de4141dac5bb237733c39ba9bbf57d91bfc303debc4997ddd |
|
MD5 | bc943cfe3b11e610190ef906fcb597f1 |
|
BLAKE2b-256 | 88ea4def9af5b5b6c2af90e885620781fa5aa77fbbc4ae622534eef2e931aa2d |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a256a6934d8814d3e184ad6ae28c3b4dd60348bedcd9efc6a4ff67585cb778e |
|
MD5 | 75abf63fa3ab02c024673aa68311e974 |
|
BLAKE2b-256 | 8d2248fe807ba540cbce2c2197085d517128cf6f31aed47ed8ba68eb3f33779b |