@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.40.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 680a23577f2d13ad6ba7ff46a707a41c8c6c74d1afdaa87f238adfc673867ec3 |
|
MD5 | 2de9bbb05814ad81a1d4f9e10b4af1b0 |
|
BLAKE2b-256 | 42a679e28a2e58cf3aae4cefef258970dbc7c39c971e3af23518a22197805e1d |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.40-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39dd43e340aa24fb61b41c9cbb957902a4f76355364f2ab20bb2c07261db36b4 |
|
MD5 | dd0e50232aef9dc5b137bf74992e68a0 |
|
BLAKE2b-256 | 165c09650c09957339febe0d67e171b3a2e11fe440124bd7e4ffa3176149f534 |