@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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 306f3c1503e200a77e22336fe2ad75c4dc3d80186f4cf15b90576526b5f9db47 |
|
MD5 | 238d085aa5c1259b259da2ffa291b2bf |
|
BLAKE2b-256 | 4cbf15263b33cbea48dfd79e6a9c651f1f690960441fdb18fd95d5c2cc8ee15b |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6608b7cf157a245a759a110dfadc4cb42d9c4dbc3e355ae84b534e76282d0ca3 |
|
MD5 | b2609c824d6ae6e8a4b8b27bd58cb5b9 |
|
BLAKE2b-256 | 689d1703552dd8c13219966b875296590e5d8e8bb97d7a0d5be5705c0f600d50 |