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
show all
Defined in:
(unknown)

Overview

Note:

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
}

A notification associated with a budget. A budget can have up to five notifications.

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to ten 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 comparisonOperator of GREATER_THAN

  • A notification threshold of 80

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operatorString

The comparison used for this notification.

Possible values:

  • GREATER_THAN
  • LESS_THAN
  • EQUAL_TO

Returns:

  • (String)

    The comparison used for this notification.

#notification_typeString

Whether the notification is for how much you have spent (ACTUAL) or for how much you are forecasted to spend (FORECASTED).

Possible values:

  • ACTUAL
  • FORECASTED

Returns:

  • (String)

    Whether the notification is for how much you have spent (ACTUAL) or for how much you are forecasted to spend (FORECASTED).

#thresholdFloat

The threshold associated with a notification. Thresholds are always a percentage.

Returns:

  • (Float)

    The threshold associated with a notification.

#threshold_typeString

The type of threshold for a notification. For ACTUAL thresholds, AWS notifies you when you go over the threshold, and for FORECASTED thresholds AWS notifies you when you are forecasted to go over the threshold.

Possible values:

  • PERCENTAGE
  • ABSOLUTE_VALUE

Returns:

  • (String)

    The type of threshold for a notification.