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

Class: Aws::Budgets::Types::CreateNotificationRequest

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 CreateNotificationRequest data as a hash:

{
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  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
    notification_state: "OK", # accepts OK, ALARM
  },
  subscribers: [ # required
    {
      subscription_type: "SNS", # required, accepts SNS, EMAIL
      address: "SubscriberAddress", # required
    },
  ],
}

Request of CreateNotification

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

The accountId that is associated with the budget that you want to create a notification for.

Returns:

  • (String) 


567
568
569
570
571
572
573
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 567

class CreateNotificationRequest < Struct.new(
  :account_id,
  :budget_name,
  :notification,
  :subscribers)
  include Aws::Structure
end

#budget_name ⇒ String

The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.

Returns:

  • (String) 


567
568
569
570
571
572
573
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 567

class CreateNotificationRequest < Struct.new(
  :account_id,
  :budget_name,
  :notification,
  :subscribers)
  include Aws::Structure
end

#notification ⇒ Types::Notification

The notification that you want to create.

Returns:



567
568
569
570
571
572
573
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 567

class CreateNotificationRequest < Struct.new(
  :account_id,
  :budget_name,
  :notification,
  :subscribers)
  include Aws::Structure
end

#subscribers ⇒ Array<Types::Subscriber>

A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.

Returns:



567
568
569
570
571
572
573
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 567

class CreateNotificationRequest < Struct.new(
  :account_id,
  :budget_name,
  :notification,
  :subscribers)
  include Aws::Structure
end