@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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e639d4683b3f5369bb48028ec526ae37b1e1f2ba4bb7e9a2bd6a93ffed3b251f |
|
MD5 | 625d60f684b391f8c7c20d914773995d |
|
BLAKE2b-256 | d8d7ed1bce33d49388c7d8ab08e39b2193461d5baed51680174a5274c1446a32 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5407b14ceb817edc3698369c1e45aa4f3e062f4500b64273ba1e412ba8443bd0 |
|
MD5 | 04d853ec67bc06b267c09db09eed4bc1 |
|
BLAKE2b-256 | 3a12fb36d0ce490b174716e3498a11b67c42fba9d7d6f17eb4a090201d1fd4e5 |