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

Class: Aws::Budgets::Types::Subscriber

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

{
  subscription_type: "SNS", # required, accepts SNS, EMAIL
  address: "SubscriberAddress", # required
}

The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

For example, an email subscriber would have the following parameters:

  • A subscriptionType of EMAIL

  • An address of example@example.com

Instance Attribute Summary collapse

Instance Attribute Details

#addressString

The address that AWS sends budget notifications to, either an SNS topic or an email.

AWS validates the address for a CreateSubscriber request with the .* regex.

Returns:

  • (String)


1259
1260
1261
1262
1263
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1259

class Subscriber < Struct.new(
  :subscription_type,
  :address)
  include Aws::Structure
end

#subscription_typeString

The type of notification that AWS sends to a subscriber.

Returns:

  • (String)


1259
1260
1261
1262
1263
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1259

class Subscriber < Struct.new(
  :subscription_type,
  :address)
  include Aws::Structure
end