You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Budgets::Types::Notification

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb

Overview

Note:

When making an API call, you may pass Notification data as a 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 model. Each budget may contain multiple notifications with different settings.

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operatorString

The comparison operator of a notification. Currently we support less than, equal to and greater than.

Returns:

  • (String)


744
745
746
747
748
749
750
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 744

class Notification < Struct.new(
  :notification_type,
  :comparison_operator,
  :threshold,
  :threshold_type)
  include Aws::Structure
end

#notification_typeString

The type of a notification. It should be ACTUAL or FORECASTED.

Returns:

  • (String)


744
745
746
747
748
749
750
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 744

class Notification < Struct.new(
  :notification_type,
  :comparison_operator,
  :threshold,
  :threshold_type)
  include Aws::Structure
end

#thresholdFloat

The threshold of a notification. It should be a number between 0 and 1,000,000,000.

Returns:

  • (Float)


744
745
746
747
748
749
750
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 744

class Notification < Struct.new(
  :notification_type,
  :comparison_operator,
  :threshold,
  :threshold_type)
  include Aws::Structure
end

#threshold_typeString

The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.

Returns:

  • (String)


744
745
746
747
748
749
750
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 744

class Notification < Struct.new(
  :notification_type,
  :comparison_operator,
  :threshold,
  :threshold_type)
  include Aws::Structure
end