@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.14.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25120c88ec3090d9bd4799d6304fd659285a26faadc0a8c6377125a62e5b2651 |
|
MD5 | ce2658acff35a1fe4f5977a6ad10eacb |
|
BLAKE2b-256 | b12d23f70b1693a5b4c853bb8e78c50795d013cadd2e10d660dee9f18e0c8219 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea38406b93199c6052c662e608b66a3777c453129197d93d34dd11ae9d1cf472 |
|
MD5 | e18c346ed13765f4fd01df4e13d4eb1d |
|
BLAKE2b-256 | 394015997ec9fccfab0a1b635c7f5a9a4bb8a5082c36cfcced0bb717d37399a7 |