Metadata-Version: 2.1
Name: aws-cdk-billing-alarm
Version: 1.0.1
Summary: aws-cdk-billing-alarm
Home-page: https://github.com/alvyn279/aws-cdk-billing-alarm.git
Author: Alvyn Le<alvyn279@gmail.com>
License: MIT
Project-URL: Source, https://github.com/alvyn279/aws-cdk-billing-alarm.git
Description: # aws-cdk-billing-alarm
        
        [![Build status](https://github.com/alvyn279/aws-cdk-billing-alarm/workflows/build/badge.svg)](https://github.com/alvyn279/aws-cdk-billing-alarm/actions/)
        [![NPM version](https://badge.fury.io/js/aws-cdk-billing-alarm.svg)](https://www.npmjs.com/package/aws-cdk-billing-alarm)
        [![PyPI version](https://badge.fury.io/py/aws-cdk-billing-alarm.svg)](https://pypi.org/project/aws-cdk-billing-alarm/)
        [![Mentioned in Awesome CDK](https://awesome.re/mentioned-badge.svg)](https://github.com/kolomied/awesome-cdk)
        
        A CDK construct that sets up email notification for when you exceed a given AWS estimated charges amount.
        
        Create this construct in any stack you find appropriate **with only a few lines**. This construct is an implementation of the manual
        setup described on [AWS Estimated Charges Monitoring](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/gs_monitor_estimated_charges_with_cloudwatch.html).
        
        ## Get Started
        
        ### Pre-Requisites
        
        > **IMPORTANT!** Only complete ***Step 1: Enable Billing Alerts*** of the following documentation link. This construct will take
        > care of creating the rest of the resources for you.
        
        You must first enable billing alerts from the AWS Console as per [documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/gs_monitor_estimated_charges_with_cloudwatch.html#gs_turning_on_billing_metrics).
        
        Billing alerts will allow your AWS account to start collecting billing metrics (`EstimatedCharges`) on a periodic 6-hour basis.
        
        ### Installation
        
        #### [Node documentation](https://www.npmjs.com/package/aws-cdk-billing-alarm)
        
        ```shell
        npm install --save aws-cdk-billing-alarm
        ```
        
        #### [Python documentation](https://pypi.org/project/aws-cdk-billing-alarm/)
        
        ```shell
        pip install aws-cdk-billing-alarm
        ```
        
        ### Usage
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        import aws_cdk.core as cdk
        from aws_cdk_billing_alarm import BillingAlarm
        
        class CdkStack(cdk.Stack):
            def __init__(self, scope, id, *, description=None, env=None, stackName=None, tags=None, synthesizer=None, terminationProtection=None, analyticsReporting=None):
                super().__init__(scope, id, description=description, env=env, stackName=stackName, tags=tags, synthesizer=synthesizer, terminationProtection=terminationProtection, analyticsReporting=analyticsReporting)
        
                # Create an alarm that emails `admin@example.com`
                # if estimated charges exceed 50 USD
                BillingAlarm(self, "AWSAccountBillingAlarm",
                    monthly_threshold=50,
                    emails=["admin@example.com"]
                )
        ```
        
        ### Post-Deployment
        
        Confirm the subscription to the newly created topic for the emails you specified as endpoints in `BillingAlarmProps`.
        You can do so by clicking on the `SubscribeURL` of the JSON email you received.
        
        > **Note**: If you did not receive the email, you can fire a **Request confirmation** for the subscription from the AWS SNS Console.
        
        ## Limitations
        
        * [USD currency](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html#creating_billing_alarm_with_wizard)
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Typing :: Typed
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
