@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.58.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7184210f343618daf805729e935885b089a88ffede26f9ec5813cfc589f6a232 |
|
MD5 | adbd66965dc2aa5ceb8bd8034d8e6271 |
|
BLAKE2b-256 | d5dfc355fd0000ba46844bbbf0cef43c95bed2dfab6448bbdf508f1870f668fe |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.58-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11f5a477c709e96aafc5b076bc89e36650def7fdb96a849474e6a47072d67af0 |
|
MD5 | d8363a50c69830b4b1a1efed894fe088 |
|
BLAKE2b-256 | 0a31e96666f88a3919cdb2f08dcee2f1b20b7cab59cdfa158d9ad521b0c83f43 |