@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.19.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 597dae042d62317eac50f8d25609813ba1f63a34edb526fb8c2192c649781a88 |
|
MD5 | 057afdbd053a3f8877de2429106149bf |
|
BLAKE2b-256 | 8b8e8e83c0fe5e25012ce4236a52ceae2d6d80cbf7fb27c7f26fa6872d22d77c |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6be5b5934612f49ecbc68e7400ce13d9618e1480bc809ddd9d1e7f11ef3229ca |
|
MD5 | 7e2849c847c3e34f356a82e35ffff68f |
|
BLAKE2b-256 | aa0c4cdecc216b292127d7966681ce00110278b6b138622abf31a9f65078b82b |