@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.18.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2457737d07cad581b723515c70b37995d1cb9657faf2748c6564eded7db94fc9 |
|
MD5 | f2fa8ba5ab5abe80ad29d736135cbed8 |
|
BLAKE2b-256 | ae8945a66590d7fed9637e04b0d467a3de7d92f2c608ab98f7ceba3784aa45f6 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1f0924380eaca2719234e63786df57895b578e27632617b7249864f7d4f0736 |
|
MD5 | 8eeb2b0a16db3898715fcab137eb9663 |
|
BLAKE2b-256 | 51721cdb65965bfd6864ac952d9c906c5e3ffc719639cb39ebfeeff8ee66a15d |