[](https://badge.fury.io/js/cdk-ecr-image-scan-notify)
[](https://badge.fury.io/py/cdk-ecr-image-scan-notify)
# cdk-ecr-image-scan-notify
cdk-ecr-image-scan-notify is an AWS CDK construct library that notify the slack channel of Amazon ECR image scan results.
## Overview
Amazon EventBridge (CloudWatch Events) detects the image scan execution and starts the Lambda function.
The Lambda function summarizes the scan results, formatting them and notifying Slack.
Basic scanning
Enhanced scanning (Support for initial scan only)
Click on an image name to go to the scan results page.
## Getting Started
### TypeScript
Installation
```
$ yarn add cdk-ecr-image-scan-notify
```
Usage
```python
import * as cdk from 'aws-cdk-lib';
import { EcrImageScanNotify } from 'cdk-ecr-image-scan-notify';
const mockApp = new cdk.App();
const stack = new cdk.Stack(mockApp, '<your-stack-name>');
new EcrImageScanNotify(stack, 'ecr-image-scan-notify', {
webhookUrl: '<your-incoming-webhook-url>',
});
```
Deploy!
```
$ cdk deploy
```
### Python
Installation
```
$ pip install cdk-ecr-image-scan-notify
```
Usage
```py
import aws_cdk as cdk
from cdk_ecr_image_scan_notify import EcrImageScanNotify
app = cdk.App()
stack = cdk.Stack(app, "<your-stack-name>", env={'region': 'ap-northeast-1'})
EcrImageScanNotify(stack, "EcrImageScanNotify",
webhook_url = '<your-incoming-webhook-url>',
)
```
Deploy!
```
$ cdk deploy
```
Raw data
{
"_id": null,
"home_page": "https://github.com/hayao-k/cdk-ecr-image-scan-notify.git",
"name": "cdk-ecr-image-scan-notify",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "hayao-k<30886141+hayao-k@users.noreply.github.com>",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c5/03/316ead39de94e1f0d9c7a743f29e0bd0ec2e44b4848791e0e223c1c8d3fc/cdk-ecr-image-scan-notify-1.0.242.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/js/cdk-ecr-image-scan-notify)\n[](https://badge.fury.io/py/cdk-ecr-image-scan-notify)\n\n\n# cdk-ecr-image-scan-notify\n\ncdk-ecr-image-scan-notify is an AWS CDK construct library that notify the slack channel of Amazon ECR image scan results.\n\n## Overview\n\nAmazon EventBridge (CloudWatch Events) detects the image scan execution and starts the Lambda function.\nThe Lambda function summarizes the scan results, formatting them and notifying Slack.\n\nBasic scanning\n\n\n\nEnhanced scanning (Support for initial scan only)\n\n\n\nClick on an image name to go to the scan results page.\n\n\n\n## Getting Started\n\n### TypeScript\n\nInstallation\n\n```\n$ yarn add cdk-ecr-image-scan-notify\n```\n\nUsage\n\n```python\nimport * as cdk from 'aws-cdk-lib';\nimport { EcrImageScanNotify } from 'cdk-ecr-image-scan-notify';\n\nconst mockApp = new cdk.App();\nconst stack = new cdk.Stack(mockApp, '<your-stack-name>');\n\nnew EcrImageScanNotify(stack, 'ecr-image-scan-notify', {\n webhookUrl: '<your-incoming-webhook-url>',\n});\n```\n\nDeploy!\n\n```\n$ cdk deploy\n```\n\n### Python\n\nInstallation\n\n```\n$ pip install cdk-ecr-image-scan-notify\n```\n\nUsage\n\n```py\nimport aws_cdk as cdk\nfrom cdk_ecr_image_scan_notify import EcrImageScanNotify\n\napp = cdk.App()\nstack = cdk.Stack(app, \"<your-stack-name>\", env={'region': 'ap-northeast-1'})\n\nEcrImageScanNotify(stack, \"EcrImageScanNotify\",\n webhook_url = '<your-incoming-webhook-url>',\n)\n```\n\nDeploy!\n\n```\n$ cdk deploy\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "cdk-ecr-image-scan-notify is an AWS CDK construct library that notify the slack channel of Amazon ECR image scan results",
"version": "1.0.242",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f7c39faa2236b3b0dfb54130ae413938f69cfcf6a2d85d9a347985f0a19876b6",
"md5": "f9661c7c0d5a808f8496ec1d026c111b",
"sha256": "20fbaacd73dcd5eaeac8a387884d9d3e540719f577b4373397af49eea3398d11"
},
"downloads": -1,
"filename": "cdk_ecr_image_scan_notify-1.0.242-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9661c7c0d5a808f8496ec1d026c111b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 30206,
"upload_time": "2023-04-03T15:55:40",
"upload_time_iso_8601": "2023-04-03T15:55:40.058274Z",
"url": "https://files.pythonhosted.org/packages/f7/c3/9faa2236b3b0dfb54130ae413938f69cfcf6a2d85d9a347985f0a19876b6/cdk_ecr_image_scan_notify-1.0.242-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c503316ead39de94e1f0d9c7a743f29e0bd0ec2e44b4848791e0e223c1c8d3fc",
"md5": "3045ccd4f02701857983e7d5cfa797b4",
"sha256": "4bd3f75d8fbcd6d0836156e13187f6a6167fc54107ab635bf9941cf78ca35b69"
},
"downloads": -1,
"filename": "cdk-ecr-image-scan-notify-1.0.242.tar.gz",
"has_sig": false,
"md5_digest": "3045ccd4f02701857983e7d5cfa797b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 31366,
"upload_time": "2023-04-03T15:55:42",
"upload_time_iso_8601": "2023-04-03T15:55:42.834931Z",
"url": "https://files.pythonhosted.org/packages/c5/03/316ead39de94e1f0d9c7a743f29e0bd0ec2e44b4848791e0e223c1c8d3fc/cdk-ecr-image-scan-notify-1.0.242.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-03 15:55:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "hayao-k",
"github_project": "cdk-ecr-image-scan-notify.git",
"lcname": "cdk-ecr-image-scan-notify"
}
JSON
