@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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8670859a49fd0ecb0ce94459312659c9bca713bda9830fab8f34e12e63984280 |
|
MD5 | 643a0b37a63fc6aae48e6ecd2a7b175e |
|
BLAKE2b-256 | 74cfafae05bd125956377f104eff4fc154f8476109fa54d8535e81888640aa76 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b58687e4033a4dc38523c81816e015a419582bf95e7938ffd608a0f38c05cc42 |
|
MD5 | 41f0a69c1e49509757ecf29d35633c1a |
|
BLAKE2b-256 | 1afee5cc419e095f22c8d22f005dffb935cfc7178e26769c04141723411e5e3e |