@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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb6784f1d8736facb3d6f0ee4c2c5eb3767e16ae6ce52151a63b7b0f11dd7110 |
|
MD5 | 691be3527f447ba1553d36028739f7ac |
|
BLAKE2b-256 | 61e5e8cd2c0e2401a080f5d7e7b0d48d501d4fae509efbb47d6e2535bf7bc85f |
Hashes for aws_prototyping_sdk.pdk_nag-0.14.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb811a7a5bed26ebc11e7cecbac0f6337036f4c689bf7b2ff025ad264627de07 |
|
MD5 | 54a7cbd406a714c0d06b8fc5897b1016 |
|
BLAKE2b-256 | 1cea11ce19a7ef20ad5c22ab8eba7d82a056a0c99192366c5abf27cbce326f67 |