@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.13.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bae449f61e5d0eeda083522d12368bba997fd7e0fee1ecf5df8e58e505509d90 |
|
MD5 | b8d4a86964ae7da1676ff70a1e3c6d98 |
|
BLAKE2b-256 | ac091adfdee4c4c33487e1d7a922744f42f4746f1c1e04304f00a431898e160d |
Hashes for aws_prototyping_sdk.pdk_nag-0.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | acc4f96b5727eb95eb37af7660b77c280578795d05b3538d99b142226de8daad |
|
MD5 | 618abc9da1486482b28681943cf5f392 |
|
BLAKE2b-256 | 23b311ec998ff366ad1af30ac825acb243e57b0442cb3afd1806eb4596a9be00 |