@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.49.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | facf1f7b0921c66186dee91850c84e1599b1efb179584703b9fafeef9e7c2069 |
|
MD5 | 0477be97c6ef27726ae66f99632b9493 |
|
BLAKE2b-256 | a0689bb57901aeca63de43a58e19c020006309f230103e1b3ff6af5a241ac712 |
Hashes for aws_prototyping_sdk.pdk_nag-0.19.49-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd342db5565c10cf68a59e2d7adbcf4525f499dc34f68bed1f2bfe2ed78a5356 |
|
MD5 | 70aa21ab45da0b100c3aec770a7d148d |
|
BLAKE2b-256 | 72416fc8f369ca7cda12076eebce86e4684d648ffab5c6895945b60ff2757a01 |