{"id":15547487,"url":"https://github.com/stefanfreitag/cdk-budget-notifier","last_synced_at":"2025-08-21T17:31:51.701Z","repository":{"id":45165483,"uuid":"279045773","full_name":"stefanfreitag/cdk-budget-notifier","owner":"stefanfreitag","description":"Create simple AWS Budgets notifications","archived":false,"fork":false,"pushed_at":"2024-12-01T20:19:17.000Z","size":1868,"stargazers_count":15,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-15T13:50:24.452Z","etag":null,"topics":["aws","budgets","cdk"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stefanfreitag.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-12T10:59:05.000Z","updated_at":"2024-12-01T20:14:28.000Z","dependencies_parsed_at":"2023-02-06T06:30:39.654Z","dependency_job_id":"c660e169-e9d3-4e18-9ba6-df432cc00e5e","html_url":"https://github.com/stefanfreitag/cdk-budget-notifier","commit_stats":{"total_commits":195,"total_committers":8,"mean_commits":24.375,"dds":0.6205128205128205,"last_synced_commit":"1579813adf59b63922a5bfdb40d61c7fa4c3dcdc"},"previous_names":[],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanfreitag%2Fcdk-budget-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanfreitag%2Fcdk-budget-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanfreitag%2Fcdk-budget-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanfreitag%2Fcdk-budget-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stefanfreitag","download_url":"https://codeload.github.com/stefanfreitag/cdk-budget-notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230523761,"owners_count":18239445,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","budgets","cdk"],"created_at":"2024-10-02T13:09:22.729Z","updated_at":"2024-12-20T02:06:42.063Z","avatar_url":"https://github.com/stefanfreitag.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AWS Budget Notifier\n\nSetup a AWS Budget notification using AWS Cloud Development Kit (CDK).\nThe construct supports notifying to\n\n- users via e-mail. Up to 10 e-mail addresses are supported\n- an SNS topic  \n  The SNS topic needs to exist and publishing to the topic needs to be allowed.\n\n## Properties\n\n[API.md](API.md)\n\n## Example usages\n\n### Notification on breaching forecasted cost\n\nThis example is handy for keeping control over your private AWS Bill.\nFor myself I aim to not spent more than 10 Euro / 10 USD per month and this alarm\nreminds me.\n\n```typescript\nconst app = new cdk.App();\nconst stack = new Stack(app, \"BudgetNotifierStack\");\n\n// Define the SNS topic and setup the resource policy\nconst topic = new Topic(stack, \"topic\");\n\nconst statement = new PolicyStatement({\n  effect: Effect.ALLOW,\n  principals: [new ServicePrincipal(\"budgets.amazonaws.com\")],\n  actions: [\"SNS:Publish\"],\n  sid: \"Allow budget to publish to SNS\"\n});\ntopic.addToResourcePolicy(statement);\n\n// Setup the budget notifier and pass the ARN of the SNS topic\nnew BudgetNotifier(stack, \"notifier\", {\n  topicArn: topic.topicArn,\n  // Filter on the availability zone `eu-central-1`\n  availabilityZones: [\"eu-central-1\"],\n  costCenter: \"myCostCenter\",\n  // Limit and unit defining the budget limit\n  limit: 10,\n  unit: \"USD\",\n  // When breaching the threshold of 85% of the 10 USD notifications will be send out.\n  threshold: 85,\n  notificationType: NotificationType.FORECASTED,\n});\n\n```\n\n### Notification via e-Mail\n\nAs alternative to the notification via SNS you can specify a list of e-mail\nrecipients.\n\n```typescript\nconst app = new cdk.App();\nconst stack = new Stack(app, \"BudgetNotifierStack\");\n\nnew BudgetNotifier(stack, 'notifier', {\n  recipients: ['john.doe@foo.bar'],\n  // Filter on the availability zone `eu-central-1`\n  availabilityZones: ['eu-central-1'],\n  costCenter: 'MyCostCenter',\n  // Limit and unit defining the budget limit\n  limit: 10,\n  unit: 'USD',\n  // When breaching the threshold of 85% of the 10 USD notifications will be send out.\n  threshold: 85,\n  notificationType: NotificationType.FORECASTED,\n});\n```\n\n## Contributions\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/dedominicisfa\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/23100791?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ededominicisfa\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"http://p6m7g8.github.io\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/34295?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ePhilip M. Gollucci\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n## Links\n\n- [AWS Cloud Development Kit (CDK)](https://github.com/aws/aws-cdk)\n- [Cost Explorer filters](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-filtering.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefanfreitag%2Fcdk-budget-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstefanfreitag%2Fcdk-budget-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefanfreitag%2Fcdk-budget-notifier/lists"}