cdk-ecr-image-scan-notify


Namecdk-ecr-image-scan-notify JSON
Version 0.0.383 PyPI version JSON
download
home_pagehttps://github.com/hayao-k/cdk-ecr-image-scan-notify.git
Summarycdk-ecr-image-scan-notify is an AWS CDK construct library that notify the slack channel of Amazon ECR image scan results
upload_time2022-06-30 00:39:12
maintainer
docs_urlNone
authorhayao-k<hayaok333@gmail.com>
requires_python~=3.7
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![NPM version](https://badge.fury.io/js/cdk-ecr-image-scan-notify.svg)](https://badge.fury.io/js/cdk-ecr-image-scan-notify)
[![PyPI version](https://badge.fury.io/py/cdk-ecr-image-scan-notify.svg)](https://badge.fury.io/py/cdk-ecr-image-scan-notify)
![Release](https://github.com/hayao-k/cdk-ecr-image-scan-notify/workflows/release/badge.svg)

# 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

![](https://raw.githubusercontent.com/hayao-k/cdk-ecr-image-scan-notify/main/images/basic-scanning.png)

Enhanced scanning (Support for initial scan only)

![](https://raw.githubusercontent.com/hayao-k/cdk-ecr-image-scan-notify/main/images/enhanced-scanning.png)

Click on an image name to go to the scan results page.

![](https://github.com/hayao-k/ecr-image-scan-findings-to-slack/raw/master/docs/images/scan-result.png)

## Getting Started

### TypeScript

Installation

```
$ yarn add cdk-ecr-image-scan-notify
```

Usage

```python
import * as cdk from '@aws-cdk/core';
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.core 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<hayaok333@gmail.com>",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/91/7e/4b6353edfba0511a7a3c92861ecdee71748db0c2e3321d65ee94e434355a/cdk-ecr-image-scan-notify-0.0.383.tar.gz",
    "platform": null,
    "description": "[![NPM version](https://badge.fury.io/js/cdk-ecr-image-scan-notify.svg)](https://badge.fury.io/js/cdk-ecr-image-scan-notify)\n[![PyPI version](https://badge.fury.io/py/cdk-ecr-image-scan-notify.svg)](https://badge.fury.io/py/cdk-ecr-image-scan-notify)\n![Release](https://github.com/hayao-k/cdk-ecr-image-scan-notify/workflows/release/badge.svg)\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![](https://raw.githubusercontent.com/hayao-k/cdk-ecr-image-scan-notify/main/images/basic-scanning.png)\n\nEnhanced scanning (Support for initial scan only)\n\n![](https://raw.githubusercontent.com/hayao-k/cdk-ecr-image-scan-notify/main/images/enhanced-scanning.png)\n\nClick on an image name to go to the scan results page.\n\n![](https://github.com/hayao-k/ecr-image-scan-findings-to-slack/raw/master/docs/images/scan-result.png)\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/core';\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.core 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\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": "0.0.383",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "376a6af012e9558cb3dbf9c59aae8ec4",
                "sha256": "431dcf4b0266814e8f54eba84a72c38da1c282270a399bf3132c74dc28c286c3"
            },
            "downloads": -1,
            "filename": "cdk_ecr_image_scan_notify-0.0.383-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "376a6af012e9558cb3dbf9c59aae8ec4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.7",
            "size": 26931,
            "upload_time": "2022-06-30T00:39:10",
            "upload_time_iso_8601": "2022-06-30T00:39:10.206269Z",
            "url": "https://files.pythonhosted.org/packages/56/b1/ef7852dfdcaaf7c4e9f98f7306e1ecd6d040337a656394d79f6559d05564/cdk_ecr_image_scan_notify-0.0.383-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "304f448b42fdbf7bf6e4c86eb93915f5",
                "sha256": "9b141fa9e9b698f2786e2790807c4c72e7ac7deae10f6fe9cfc40e73d9d512f3"
            },
            "downloads": -1,
            "filename": "cdk-ecr-image-scan-notify-0.0.383.tar.gz",
            "has_sig": false,
            "md5_digest": "304f448b42fdbf7bf6e4c86eb93915f5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.7",
            "size": 28034,
            "upload_time": "2022-06-30T00:39:12",
            "upload_time_iso_8601": "2022-06-30T00:39:12.742363Z",
            "url": "https://files.pythonhosted.org/packages/91/7e/4b6353edfba0511a7a3c92861ecdee71748db0c2e3321d65ee94e434355a/cdk-ecr-image-scan-notify-0.0.383.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-30 00:39:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "hayao-k",
    "github_project": "cdk-ecr-image-scan-notify.git",
    "lcname": "cdk-ecr-image-scan-notify"
}
        
Elapsed time: 0.52536s