@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.12.20.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3a2075e00cc99d63436d96847a2cd9778f31e36672e045ae6da1a9f615e2530 |
|
MD5 | 278b01bd87c8b600e18614dba44cfaeb |
|
BLAKE2b-256 | 73bcf5a6b39d02b24c6e3a64fa65fd212e56d1b6f00d3fb188ec2ca9d4321434 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14b9c66af2437f24814e7f283102ac3d2f16f263b8b8e53702301df8144965a5 |
|
MD5 | 9546871ce5c88a7f3c6866c089a13427 |
|
BLAKE2b-256 | 4efff172dd53307ba8b778226afd2956317b15774b7f105cd1fd420f612b4672 |