@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.43.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79d652b93498b87d4ee828605ae5956d7cf54bfc2b77f97561a88f21bfc9d308 |
|
MD5 | b644afaee45c873d4e473d74d0a5efcc |
|
BLAKE2b-256 | 45b40469a794374dc09bbae8f76504ba3500daac7a9d49c58d88eac4aa362fa5 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.43-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a9bc91a1494f3b29ba7fecc01106e86772e1348ee8720108ed02a575c01e30e |
|
MD5 | 2215f47c73224edc926d2e03164cf8fd |
|
BLAKE2b-256 | 6ca77f4274f321bd0a88eaa2f6f997cdbd3ed83e8055ac33eda94d4a3d7efe8d |