## PDK Nag
PDKNag ships with a helper utility that automatically configures CDKNag within your application.
```python
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:
```shell
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:
```shell
cdk synth --strict
```
### Instrumenting custom NagPacks
By default, when creating a PDKNag application the [AwsSolutions](https://github.com/cdklabs/cdk-nag/blob/main/RULES.md) NagPack is instrumented. In order to specify custom NagPacks to instrument, you can configure the PDKApp as follows:
```python
import { PDKNag, AwsPrototypingChecks } from "@aws-prototyping-sdk/pdk-nag";
const app = PDKNag.app({
nagPacks: [new AwsPrototypingChecks()]
});
```
In this example, the [AwsPrototypingChecks](https://github.com/aws/aws-prototyping-sdk/blob/mainline/packages/pdk-nag/src/packs/README.md) NagPack has been configured to run instead of the default. Multiple NagPacks can also be instrumented by adding NagPack instances to the `nagPacks` array;
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-prototyping-sdk",
"name": "aws-prototyping-sdk.pdk-nag",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "AWS APJ COPE<apj-cope@amazon.com>",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/59/18/46560368a8d9a8d1306f4e321a35da4b829005c47b10c8db83a23158381f/aws_prototyping_sdk.pdk_nag-0.19.68.tar.gz",
"platform": null,
"description": "## PDK Nag\n\nPDKNag ships with a helper utility that automatically configures CDKNag within your application.\n\n```python\nconst app = PDKNag.app();\nconst stack = new Stack(app, 'MyStack');\n...\n```\n\nAs shown above, this will configure your application to have CDKNag run on synthesis.\n\nBy default, CDK will trigger a failure on `synth` if any errors are encountered. To relax these, run the following:\n\n```shell\ncdk synth --ignore-errors\n```\n\nConversely, CDK will not fail on synth if warnings are detected. To enforce that all warnings are resolved, run the following command:\n\n```shell\ncdk synth --strict\n```\n\n### Instrumenting custom NagPacks\n\nBy default, when creating a PDKNag application the [AwsSolutions](https://github.com/cdklabs/cdk-nag/blob/main/RULES.md) NagPack is instrumented. In order to specify custom NagPacks to instrument, you can configure the PDKApp as follows:\n\n```python\nimport { PDKNag, AwsPrototypingChecks } from \"@aws-prototyping-sdk/pdk-nag\";\n\nconst app = PDKNag.app({\n nagPacks: [new AwsPrototypingChecks()]\n});\n```\n\nIn this example, the [AwsPrototypingChecks](https://github.com/aws/aws-prototyping-sdk/blob/mainline/packages/pdk-nag/src/packs/README.md) NagPack has been configured to run instead of the default. Multiple NagPacks can also be instrumented by adding NagPack instances to the `nagPacks` array;\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "@aws-prototyping-sdk/pdk-nag",
"version": "0.19.68",
"project_urls": {
"Homepage": "https://github.com/aws/aws-prototyping-sdk",
"Source": "https://github.com/aws/aws-prototyping-sdk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c99c7ec0b475be54650cb1328ab762d7a47cc1af54770d696f484c31bfb354f0",
"md5": "392ee5e0becc31617f4d7006742351fc",
"sha256": "5f976b3e86b8e0424078ea2c367e09aaf009ca82465a6de3e106513b00e6f252"
},
"downloads": -1,
"filename": "aws_prototyping_sdk.pdk_nag-0.19.68-py3-none-any.whl",
"has_sig": false,
"md5_digest": "392ee5e0becc31617f4d7006742351fc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 96492,
"upload_time": "2023-08-24T23:17:13",
"upload_time_iso_8601": "2023-08-24T23:17:13.562831Z",
"url": "https://files.pythonhosted.org/packages/c9/9c/7ec0b475be54650cb1328ab762d7a47cc1af54770d696f484c31bfb354f0/aws_prototyping_sdk.pdk_nag-0.19.68-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "591846560368a8d9a8d1306f4e321a35da4b829005c47b10c8db83a23158381f",
"md5": "357090b75126ea80f328e5afb6c8dfdd",
"sha256": "fb12fba266a38d8c877425f6b3ae20f60117982c6c06c636e1b606be8fcbccaa"
},
"downloads": -1,
"filename": "aws_prototyping_sdk.pdk_nag-0.19.68.tar.gz",
"has_sig": false,
"md5_digest": "357090b75126ea80f328e5afb6c8dfdd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 98233,
"upload_time": "2023-08-24T23:17:14",
"upload_time_iso_8601": "2023-08-24T23:17:14.903614Z",
"url": "https://files.pythonhosted.org/packages/59/18/46560368a8d9a8d1306f4e321a35da4b829005c47b10c8db83a23158381f/aws_prototyping_sdk.pdk_nag-0.19.68.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-24 23:17:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "aws-prototyping-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-prototyping-sdk.pdk-nag"
}
JSON
