@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.21.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78ff99ec6a5dc657168d72914c7d7c4234b28d25cb5e08ea5a6196efc710de3a |
|
MD5 | c8992fe9f9d3afdde025869cd88941ab |
|
BLAKE2b-256 | 530881c969faf5efb862d6978133f705fe1be6ddbdfadcf876d89a742bf273a0 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.21-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ee3d8c778a0c34696438b63a0f6dfc63d8096b13322665c0c90549adf854978 |
|
MD5 | e49420805c1c1f820313ddf387e7d767 |
|
BLAKE2b-256 | f1955c51059ff2f2a9a1cfe1da0dc3c9d24be26befe4ea3714d439b63a1cf9b6 |