@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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28616af174e50195f7d505fffad7c2015482d905b5b60d87bbdffb9282544714 |
|
MD5 | 308e4f084e2053ae74b1824e18388c91 |
|
BLAKE2b-256 | 2a4c96f5f35f03124e9048490a4594c3d135dc9a5644598a07121fa12048c352 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d509ada178308b29bbba07f91de49402c957f77ac554479e5a4b5563cb50f09b |
|
MD5 | 1e87f5ced2a9f213b1a74e4c3480b7ef |
|
BLAKE2b-256 | 09296793c22c5784a190730df0dcfa0718cc2fe28c8357be41960532059f89af |