@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.12.19.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1741bd3095686c089531faae8eead2c37e6e77b15ee639c89f47278e2e681937 |
|
MD5 | 6e38907d1ceb79fd2e1602198f5d1209 |
|
BLAKE2b-256 | 04dfa6d6e380e5d3b50b9c07cb3654d1651942fb4ca211a47cb9d8dfdcb4c3a1 |
Hashes for aws_prototyping_sdk.pdk_nag-0.12.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33f951273c047764aa94fe621fa08b1d0eadd420e5ff9f2138549a02376e6486 |
|
MD5 | 2ebad00a9dd199001013dc6b4812885f |
|
BLAKE2b-256 | b10cb8427b790a0e620d9e4a55f6bde244504560e81d0807fc894ddb680b7cab |