@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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b194ec4e930a11b1fdfde4f78be1059d01e101120db8d41c26c1e1fd71f9dee5 |
|
MD5 | b421051edf0ef6bb2d142a02a0611d9b |
|
BLAKE2b-256 | 5ce09ce0e1e7ccff0e5014302fb2032cf9efc3f58affd023b101ef3df2707f39 |
Hashes for aws_prototyping_sdk.pdk_nag-0.18.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dce44a5157a281214c371bd0c82adc28f622a6edd7fa1ce3e786ce8b3c9e93e1 |
|
MD5 | 7d8917f65f60a656803821bc40d6ef15 |
|
BLAKE2b-256 | fe7540039e6e2ab85b5e06198dfdc0c81f3ae0a4aaf9d5a4399bdadcc523cb0d |