@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.29.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82a32e1222a836c522cc275f6d5d337e3adf32324c3cc9cafab3e63ef1d70bfa |
|
MD5 | a3f51bcbab37477a06fa1278682ff00b |
|
BLAKE2b-256 | 07b72b3f361263efb8b39f0cb5c14503ed48d1fb1169f22390f99e1a4439c744 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.29-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ea0828c0a7d24d379af590e4e89faede7f6f68d732d18cd99e7ec653d4b43c3 |
|
MD5 | 62abb4784105da22451481da4135a5db |
|
BLAKE2b-256 | f92ba4a20c77e0f69fe4bc1b633e6ed11d3f7045f46ef83c155d85bb255c0fe3 |