@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.13.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4328b66398c0e725e567ff33804941ab0be894a92bc63549566af3f90a0082c7 |
|
MD5 | 69b47d5f2e100db81194919492fb9267 |
|
BLAKE2b-256 | ad3935778cf815a0ae324a0b0ecc422a96a8561decb6a061aeea2948f50083a2 |
Hashes for aws_prototyping_sdk.pdk_nag-0.13.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7f96656e27070b4fba65c55c240feb9354e30e94c126653864988feb2749c18 |
|
MD5 | 1c9b424effee16d9f536105def44241a |
|
BLAKE2b-256 | b907d3776415ee753851df501c81df7aa6349c0e2082d71bb6e1a76deaddec0f |