@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.16.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 619f7519ba2f5af476c9c2bdbb6e4b3938fdbdae3378d3e25b7a7ee5a5079b76 |
|
MD5 | 52e645e6c9a4ea15400ff692a41af41f |
|
BLAKE2b-256 | a8e82492a91f5760759e02b1eae22790d7d822941b8c1b1aeef8e17f0d249ceb |
Hashes for aws_prototyping_sdk.pdk_nag-0.16.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96a3814b79657291d096d5bde6a4a8206bc8bd481a127e36b3aaa159d11699d3 |
|
MD5 | 7d4bcc152688fe239012ab71ceaa2d4f |
|
BLAKE2b-256 | 44454471f87429b2bb091a448fe2136f8b0b5ca07fb123a90a9446abeecdda51 |