You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Budgets::Types::Notification
- Inherits:
-
Struct
- Object
- Struct
- Aws::Budgets::Types::Notification
- Defined in:
- (unknown)
Overview
When passing Notification as input to an Aws::Client method, you can use a vanilla Hash:
{
notification_type: "ACTUAL", # required, accepts ACTUAL, FORECASTED
comparison_operator: "GREATER_THAN", # required, accepts GREATER_THAN, LESS_THAN, EQUAL_TO
threshold: 1.0, # required
threshold_type: "PERCENTAGE", # accepts PERCENTAGE, ABSOLUTE_VALUE
notification_state: "OK", # accepts OK, ALARM
}
A notification that is associated with a budget. A budget can have up to ten notifications.
Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:
-
A notificationType of
ACTUAL
-
A
thresholdType
ofPERCENTAGE
-
A
comparisonOperator
ofGREATER_THAN
-
A notification
threshold
of80
Returned by:
- CreateNotificationRequest#notification
- CreateSubscriberRequest#notification
- DeleteNotificationRequest#notification
- DeleteSubscriberRequest#notification
- DescribeSubscribersForNotificationRequest#notification
- Aws::Budgets::Types::NotificationWithSubscribers#notification
- UpdateNotificationRequest#old_notification
- UpdateNotificationRequest#new_notification
- UpdateSubscriberRequest#notification
Instance Attribute Summary collapse
-
#comparison_operator ⇒ String
The comparison that is used for this notification.
-
#notification_state ⇒ String
Whether this notification is in alarm.
-
#notification_type ⇒ String
Whether the notification is for how much you have spent (
ACTUAL
) or for how much you\'re forecasted to spend (FORECASTED
). -
#threshold ⇒ Float
The threshold that is associated with a notification.
-
#threshold_type ⇒ String
The type of threshold for a notification.
Instance Attribute Details
#comparison_operator ⇒ String
The comparison that is used for this notification.
Possible values:
- GREATER_THAN
- LESS_THAN
- EQUAL_TO
#notification_state ⇒ String
Whether this notification is in alarm. If a budget notification is in
the ALARM
state, you have passed the set threshold for the budget.
Possible values:
- OK
- ALARM
#notification_type ⇒ String
Whether the notification is for how much you have spent (ACTUAL
) or
for how much you\'re forecasted to spend (FORECASTED
).
Possible values:
- ACTUAL
- FORECASTED
#threshold ⇒ Float
The threshold that is associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.
#threshold_type ⇒ String
The type of threshold for a notification. For ABSOLUTE_VALUE
thresholds, AWS notifies you when you go over or are forecasted to go
over your total cost threshold. For PERCENTAGE
thresholds, AWS
notifies you when you go over or are forecasted to go over a certain
percentage of your forecasted spend. For example, if you have a budget
for 200 dollars and you have a PERCENTAGE
threshold of 80%, AWS
notifies you when you go over 160 dollars.
Possible values:
- PERCENTAGE
- ABSOLUTE_VALUE