Class: AWSCDK::Budgets::CfnBudget::SubscriberProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Budgets::CfnBudget::SubscriberProperty

Defined in:

budgets/cfn_budget.rb

Overview

The Subscriber property type specifies who to notify for a Billing and Cost Management 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 subscription_type of EMAIL
• An address of example@example.com

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html

Instance Attribute Summary

• #address ⇒ String readonly

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

• #subscription_type ⇒ String readonly

  The type of notification that AWS sends to a subscriber.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(address:, subscription_type:) ⇒ SubscriberProperty constructor

  A new instance of SubscriberProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(address:, subscription_type:) ⇒ SubscriberProperty

Returns a new instance of SubscriberProperty.

Parameters:

• address (String) —

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

• subscription_type (String) —

  The type of notification that AWS sends to a subscriber.

# File 'budgets/cfn_budget.rb', line 1364

def initialize(address:, subscription_type:)
  @address = address
  Jsii::Type.check_type(@address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "address")
  @subscription_type = subscription_type
  Jsii::Type.check_type(@subscription_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subscriptionType")
end

Instance Attribute Details

#address ⇒ String (readonly)

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)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html#cfn-budgets-budget-subscriber-address

# File 'budgets/cfn_budget.rb', line 1377

def address
  @address
end

#subscription_type ⇒ String (readonly)

The type of notification that AWS sends to a subscriber.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html#cfn-budgets-budget-subscriber-subscriptiontype

# File 'budgets/cfn_budget.rb', line 1382

def subscription_type
  @subscription_type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'budgets/cfn_budget.rb', line 1384

def self.jsii_properties
  {
    :address => "address",
    :subscription_type => "subscriptionType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'budgets/cfn_budget.rb', line 1391

def to_jsii
  result = {}
  result.merge!({
    "address" => @address,
    "subscriptionType" => @subscription_type,
  })
  result.compact
end