Metadata-Version: 2.1
Name: cdk-budget-notifier
Version: 0.0.3
Summary: A simple AWS budget notifier.
Home-page: https://github.com/stefan.freitag/projen-budget-notifier.git
Author: Stefan Freitag<stefan.freitag@udo.edu>
License: Apache-2.0
Project-URL: Source, https://github.com/stefan.freitag/projen-budget-notifier.git
Description: # AWS Budget Notifier
        
        Setup a AWS Budget notification using AWS Cloud Development Kit (CDK).
        The construct supports notifying to
        
        * users via e-mail. Up to 10 e-mail addresses are supported
        * an SNS topic<br>
          The SNS topic needs to exist and publishing to the topic needs to be allowed.
        
        ## Example usage in a CDK Stack
        
        ```javascript
        const app = new cdk.App();
        const stack = new Stack(app, "BudgetNotifierStack");
        
        // Define the SNS topic and setup the resource policy
        const topic = new Topic(stack, "topic");
        
        const statement = new PolicyStatement({
          effect: Effect.ALLOW,
          principals: [new ServicePrincipal("budgets.amazonaws.com")],
          actions: ["SNS:Publish"],
          sid: "Allow budget to publish to SNS"
        });
        topic.addToResourcePolicy(statement);
        
        // Setup the budget notifier and pass the ARN of the SNS topic
        new BudgetNotifier(stack, "notifier", {
          topicArn: topic.topicArn,
          availabilityZones: ["eu-central-1"],
          costCenter: "myCostCenter",
          limit: 10,
          unit: "USD",
          threshold: 15,
          notificationType: NotificationType.FORECASTED,
        });
        
        ```
        
        ## Links
        
        * [AWS Cloud Development Kit (CDK)](https://github.com/aws/aws-cdk)
        * [Cost Explorer filters](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-filtering.html)
        
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: Typing :: Typed
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
