@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.19.47.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ada8216851888b5d4d97029e8ccadc33687fadb367e1ce9a3bc48cd52e0e9694 |
|
MD5 | d20d89e0db1627b7371000d285700dbf |
|
BLAKE2b-256 | 8cd1c88e6618bdeffe92bd4a29d8a2c5e0c2d8fd0e11feb4945eaebbc395c0f7 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.47-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5169ad7a3ad6d0d4787608725c25484d22b02d5ccc7d9c56aaa0f2940384b94f |
|
MD5 | 7e880b457ae81504c78db62f02b02f83 |
|
BLAKE2b-256 | cac07a865e6575b6656d114963ef800014770dff562f8739e792e8e6391f1279 |