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

Class: Aws::Budgets::Types::NotificationWithSubscribers

Inherits:

Struct

Object
Struct
Aws::Budgets::Types::NotificationWithSubscribers

show all

Defined in:: gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb

Overview

Note:

When making an API call, you may pass NotificationWithSubscribers data as a hash:

{
  notification: { # required
    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
  },
  subscribers: [ # required
    {
      subscription_type: "SNS", # required, accepts SNS, EMAIL
      address: "SubscriberAddress", # required
    },
  ],
}

A notification with subscribers. A notification can have one SNS subscriber and up to ten email subscribers, for a total of 11 subscribers.

Instance Attribute Summary collapse

#notification ⇒ Types::Notification
The notification associated with a budget.
#subscribers ⇒ Array<Types::Subscriber>
A list of subscribers who are subscribed to this notification.

Instance Attribute Details

#notification ⇒ `Types::Notification`

The notification associated with a budget.

Returns:

(Types::Notification)

# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 877

class NotificationWithSubscribers < Struct.new(
  :notification,
  :subscribers)
  include Aws::Structure
end

#subscribers ⇒ `Array<Types::Subscriber>`

A list of subscribers who are subscribed to this notification.