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

Constant Summary collapse

SENSITIVE =
[:address]

Instance Attribute Summary collapse

Instance Attribute Details

#addressString

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

When you create a subscriber, the value of Address can't contain line breaks.

Returns:

  • (String)


1309
1310
1311
1312
1313
1314
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1309

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

#subscription_typeString

The type of notification that AWS sends to a subscriber.

Returns:

  • (String)


1309
1310
1311
1312
1313
1314
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1309

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