AWS Budget
A Wing library for working with AWS Budgets
Prerequisites
Installation
npm i @winglibs/budget
Usage
⚠️ The budget refers to the entire account and not just for the current project!
Add your budget alert to the code:
bring budget;
new budget.Alert(
name: "Test",
amount: 10,
emailAddresses: ["your@email.com"],
);
Note: The budget amount is in USD.
You get an alert when your monthly payment goes over your budget.
TODO
- Set a budget alert only for resources with certain tags.
- Allow to perform automatic actions when the budget runs out.
License
This library is licensed under the MIT License.
API Reference
Table of Contents
- Classes
- Interfaces
- Structs
- Enums
Alert (preflight class)
No description
Constructor
new(props: AlertProps): Alert
Properties
No properties
Methods
No methods
AlertTfAws (preflight class)
No description
Constructor
new(props: AlertProps): AlertTfAws
Properties
No properties
Methods
No methods
AlertSim (preflight class)
No description
Constructor
new(props: AlertProps): AlertSim
Properties
No properties
Methods
No methods
Util (preflight class)
No description
Constructor
new(): Util
Properties
No properties
Methods
| Signature | Description |
|---|---|
static timeUnitToStr(timeUnit: TimeUnit): str | No description |
IAlert (interface)
No description
Properties
No properties
Methods
No methods
AlertProps (struct)
No description
Properties
| Name | Type | Description |
|---|---|---|
amount | num | No description |
emailAddresses | | No description |
name | str | No description |
timeUnit | TimeUnit? | No description |
TimeUnit (enum)
No description
Values
| Name | Description |
|---|---|
DAILY | No description |
MONTHLY | No description |
ANNUALLY | No description |