@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.45.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1acf74f7d8d52689f43540022ae602c3d5cb54f16aafd49e10ed012b44f477d9 |
|
MD5 | 747cb13264cb00cccadc93fd225a5028 |
|
BLAKE2b-256 | 058f4904c04333441d3e682bdf92a03a328c9db4cf8205bd704fefce5fe0884c |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.45-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5a937876e1984eef8578573369cfe4670816bc744310137046092b9eb89974d |
|
MD5 | f84c4f308015719c9c760b46c0cc268b |
|
BLAKE2b-256 | e14dfd10204cc6109f338632c57132c59e62b8e574c16c62f5359c1721344b6e |