@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.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2f09674885df0902b251953e85911c712dc7f2f216e7c8e7db23e7ce9aeb747 |
|
MD5 | aa547c2764c52ad1fd995c1e9d951d66 |
|
BLAKE2b-256 | 986f1ab153778763d51463670085df4a44496d28386f51a9d3885e4aef16cd7f |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 189932bda564ae0ca8e7725063f48398120554f9e598aee6101f8947ad663333 |
|
MD5 | 10c2928ab12114fcd13d73cffb77e718 |
|
BLAKE2b-256 | f690aebd31d0e5be6d13ede7169f6baca9fdfe90c5f269f654e1be3db7a90f13 |