@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.18.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 300a157c096bb384d2f60ef87dad680e0a1e84bed127b610b72951be178556f4 |
|
MD5 | 1e7fe938741af5cf69fc7cbb91e29b41 |
|
BLAKE2b-256 | 78c84ff0bc2c6c362034e834f555547395bd6f18e2da6e6cf8148c076104eb52 |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 305672033d0d19fe6751102f1cc0c25cadc4e8d62a6747f4823b2699e87926d9 |
|
MD5 | 6bc53406804ed9b358e58621ab4ca0bd |
|
BLAKE2b-256 | e9f71e37b328f820223579ff012e91fd179ded1088a16dee7001b746644fb4c3 |