gammarer.aws-budgets-notification


Namegammarer.aws-budgets-notification JSON
Version 1.2.7 PyPI version JSON
download
home_pagehttps://github.com/gammarers/aws-budgets-notification.git
SummaryAWS Budgets Notification
upload_time2024-07-20 10:04:11
maintainerNone
docs_urlNone
authoryicr<yicr@users.noreply.github.com>
requires_python~=3.8
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # AWS Budgets Notification

[![GitHub](https://img.shields.io/github/license/gammarers/aws-budgets-notification?style=flat-square)](https://github.com/gammarers/aws-budgets-notification/blob/main/LICENSE)
[![npm (scoped)](https://img.shields.io/npm/v/@gammarers/aws-budgets-notification?style=flat-square)](https://www.npmjs.com/package/@gammarers/aws-budgets-notification)
[![PyPI](https://img.shields.io/pypi/v/gammarers.aws-budgets-notification?style=flat-square)](https://pypi.org/project/gammarers.aws-budgets-notification/)
[![Nuget](https://img.shields.io/nuget/v/gammarers.CDK.AWS.BudgetNotification?style=flat-square)](https://www.nuget.org/packages/Gammarers.CDK.AWS.BudgetNotification/)
[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/gammarers/aws-budgets-notification/release.yml?branch=main&label=release&style=flat-square)](https://github.com/gammarers/aws-budgets-notification/actions/workflows/release.yml)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/gammarers/aws-budgets-notification?sort=semver&style=flat-square)](https://github.com/gammarers/aws-budgets-notification/releases)

[![View on Construct Hub](https://constructs.dev/badge?package=@gammarers/aws-budgets-notification)](https://constructs.dev/packages/@gammarers/aws-budgets-notification)

A construct library for creating AWS Budgets Notification to Slack with the AWS CDK.

## Resources

This construct creating resource list.

* SNS Topic
* ChatBot SlackChannelConfiguration
* Budgets (linked account count or self)

## Install

### TypeScript

```shell
npm install @gammarers/aws-budgets-notification
# or
yarn add @gammarers/aws-budgets-notification
```

### Python

```shell
pip install gammarers.aws-budgets-notification
```

### C# / .NET

```shell
dotnet add package Gammarers.CDK.AWS.BudgetNotification
```

## Example

```python
import { BudgetsNotification } from '@gammarers/aws-budgets-notification';

new BudgetsNotification(stack, 'BudgetsNotification', {
  slackWorkspaceId: 'T0XXXX111', // already AWS account linked your Slack.
  slackChannelId: 'XXXXXXXX', // already created your slack channel.
  budgetLimitAmount: 50,
  // optional linked account list
  linkedAccounts: [
    '111111111111',
    '222222222222',
  ],
});
```

![example notification](./docs/slack-notification-image.png)

## License

This project is licensed under the Apache-2.0 License.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/gammarers/aws-budgets-notification.git",
    "name": "gammarer.aws-budgets-notification",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "~=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "yicr<yicr@users.noreply.github.com>",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/57/1c/027f9db4cc4677d911725efc2e7f8fb8ef1689454be9dc7dcc05e42f5198/gammarer.aws-budgets-notification-1.2.7.tar.gz",
    "platform": null,
    "description": "# AWS Budgets Notification\n\n[![GitHub](https://img.shields.io/github/license/gammarers/aws-budgets-notification?style=flat-square)](https://github.com/gammarers/aws-budgets-notification/blob/main/LICENSE)\n[![npm (scoped)](https://img.shields.io/npm/v/@gammarers/aws-budgets-notification?style=flat-square)](https://www.npmjs.com/package/@gammarers/aws-budgets-notification)\n[![PyPI](https://img.shields.io/pypi/v/gammarers.aws-budgets-notification?style=flat-square)](https://pypi.org/project/gammarers.aws-budgets-notification/)\n[![Nuget](https://img.shields.io/nuget/v/gammarers.CDK.AWS.BudgetNotification?style=flat-square)](https://www.nuget.org/packages/Gammarers.CDK.AWS.BudgetNotification/)\n[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/gammarers/aws-budgets-notification/release.yml?branch=main&label=release&style=flat-square)](https://github.com/gammarers/aws-budgets-notification/actions/workflows/release.yml)\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/gammarers/aws-budgets-notification?sort=semver&style=flat-square)](https://github.com/gammarers/aws-budgets-notification/releases)\n\n[![View on Construct Hub](https://constructs.dev/badge?package=@gammarers/aws-budgets-notification)](https://constructs.dev/packages/@gammarers/aws-budgets-notification)\n\nA construct library for creating AWS Budgets Notification to Slack with the AWS CDK.\n\n## Resources\n\nThis construct creating resource list.\n\n* SNS Topic\n* ChatBot SlackChannelConfiguration\n* Budgets (linked account count or self)\n\n## Install\n\n### TypeScript\n\n```shell\nnpm install @gammarers/aws-budgets-notification\n# or\nyarn add @gammarers/aws-budgets-notification\n```\n\n### Python\n\n```shell\npip install gammarers.aws-budgets-notification\n```\n\n### C# / .NET\n\n```shell\ndotnet add package Gammarers.CDK.AWS.BudgetNotification\n```\n\n## Example\n\n```python\nimport { BudgetsNotification } from '@gammarers/aws-budgets-notification';\n\nnew BudgetsNotification(stack, 'BudgetsNotification', {\n  slackWorkspaceId: 'T0XXXX111', // already AWS account linked your Slack.\n  slackChannelId: 'XXXXXXXX', // already created your slack channel.\n  budgetLimitAmount: 50,\n  // optional linked account list\n  linkedAccounts: [\n    '111111111111',\n    '222222222222',\n  ],\n});\n```\n\n![example notification](./docs/slack-notification-image.png)\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "AWS Budgets Notification",
    "version": "1.2.7",
    "project_urls": {
        "Homepage": "https://github.com/gammarers/aws-budgets-notification.git",
        "Source": "https://github.com/gammarers/aws-budgets-notification.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "21ddb5a4316776000816df8e47cbc1e4133bbf756168176df1fdd0f82a3aa0fb",
                "md5": "36be9a7569be50d5598e642cb00e7933",
                "sha256": "8fb2122fd6948f577ea7509b77316d94c5879453b32a951887c7f784e6c9c7a0"
            },
            "downloads": -1,
            "filename": "gammarer.aws_budgets_notification-1.2.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "36be9a7569be50d5598e642cb00e7933",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.8",
            "size": 83747,
            "upload_time": "2024-07-20T10:04:09",
            "upload_time_iso_8601": "2024-07-20T10:04:09.152284Z",
            "url": "https://files.pythonhosted.org/packages/21/dd/b5a4316776000816df8e47cbc1e4133bbf756168176df1fdd0f82a3aa0fb/gammarer.aws_budgets_notification-1.2.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "571c027f9db4cc4677d911725efc2e7f8fb8ef1689454be9dc7dcc05e42f5198",
                "md5": "00dda538af3bb2f7bcae95e52c10c77d",
                "sha256": "fd7a0c181e59f1dbeff63aebbf6579a5e2cf06326bbd5b84e976192066077881"
            },
            "downloads": -1,
            "filename": "gammarer.aws-budgets-notification-1.2.7.tar.gz",
            "has_sig": false,
            "md5_digest": "00dda538af3bb2f7bcae95e52c10c77d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.8",
            "size": 85184,
            "upload_time": "2024-07-20T10:04:11",
            "upload_time_iso_8601": "2024-07-20T10:04:11.056055Z",
            "url": "https://files.pythonhosted.org/packages/57/1c/027f9db4cc4677d911725efc2e7f8fb8ef1689454be9dc7dcc05e42f5198/gammarer.aws-budgets-notification-1.2.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-20 10:04:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gammarers",
    "github_project": "aws-budgets-notification",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gammarer.aws-budgets-notification"
}
yicr<yicr@users.noreply.github.com>
Elapsed time: 0.50115s