@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.15.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b62b2c0d3864f209e15ccb9f9c8f36b412e8094e03e86dba53e1b4e92fc45d0 |
|
MD5 | ea80aeb7c183cca97e1c03908226deb4 |
|
BLAKE2b-256 | 97750b2c97a5ded194c35d269d23d49449a5b86ef02f931e748642367415bf81 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f607a9bdd92b5e65e7d75feb85a4d50560084dd08558fe0f5a1370be06997835 |
|
MD5 | 396674410c0a76668eacf355b2bebbc5 |
|
BLAKE2b-256 | 9a8132afc2aca51b236d631952c844822b87f398254d018fb99a89e0b0310ac2 |