@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.12.21.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b76d67a2477c81696819672f3f611d99695b2e585f7ea2fb60ff0ea562082199 |
|
MD5 | 4b20cd132de7a00c88e0fccc42b00961 |
|
BLAKE2b-256 | d8ca33ddc7b4c5f3745fcfcd02b2175af7a4a6719b5f355e339ff2447f017124 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.21-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4db1a5e6bf987896e0a6cb38cf7569dd5db22b45a15845bd8f127f7a7ae92807 |
|
MD5 | 0d9428a53a284c7587c951ae53e4d99b |
|
BLAKE2b-256 | e9615aafd87f957f70d648247e4baf95e61549a3ae618770b514a2855829e85c |