Class: AWSCDK::SNS::CfnTopic::SubscriptionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::SNS::CfnTopic::SubscriptionProperty

Defined in:

sns/cfn_topic.rb

Overview

Subscription is an embedded property that describes the subscription endpoints of an Amazon topic.

For full control over subscription behavior (for example, delivery policy, filtering, raw message delivery, and cross-region subscriptions), use the AWS::SNS::Subscription resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html

Instance Attribute Summary

• #endpoint ⇒ String readonly

  The endpoint that receives notifications from the Amazon topic.

• #protocol ⇒ String readonly

  The subscription's protocol.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(endpoint:, protocol:) ⇒ SubscriptionProperty constructor

  A new instance of SubscriptionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(endpoint:, protocol:) ⇒ SubscriptionProperty

Returns a new instance of SubscriptionProperty.

Parameters:

• endpoint (String) —

  The endpoint that receives notifications from the Amazon topic.

• protocol (String) —

  The subscription's protocol.

# File 'sns/cfn_topic.rb', line 753

def initialize(endpoint:, protocol:)
  @endpoint = endpoint
  Jsii::Type.check_type(@endpoint, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpoint")
  @protocol = protocol
  Jsii::Type.check_type(@protocol, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "protocol")
end

Instance Attribute Details

#endpoint ⇒ String (readonly)

The endpoint that receives notifications from the Amazon topic.

The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html#cfn-sns-topic-subscription-endpoint

# File 'sns/cfn_topic.rb', line 766

def endpoint
  @endpoint
end

#protocol ⇒ String (readonly)

The subscription's protocol.

For more information, see the Protocol parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html#cfn-sns-topic-subscription-protocol

# File 'sns/cfn_topic.rb', line 773

def protocol
  @protocol
end

Class Method Details

.jsii_properties ⇒ Object

# File 'sns/cfn_topic.rb', line 775

def self.jsii_properties
  {
    :endpoint => "endpoint",
    :protocol => "protocol",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'sns/cfn_topic.rb', line 782

def to_jsii
  result = {}
  result.merge!({
    "endpoint" => @endpoint,
    "protocol" => @protocol,
  })
  result.compact
end