Class: AWSCDK::SNS::SubscriptionOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sns/subscription_options.rb

Overview

Options for creating a new subscription.

Direct Known Subclasses

SubscriptionProps, TopicSubscriptionConfig

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint:, protocol:, dead_letter_queue: nil, delivery_policy: nil, filter_policy: nil, filter_policy_with_message_body: nil, raw_message_delivery: nil, region: nil, subscription_role_arn: nil) ⇒ SubscriptionOptions

Returns a new instance of SubscriptionOptions.

Parameters:

  • endpoint (String) —

    The subscription endpoint.

  • protocol (AWSCDK::SNS::SubscriptionProtocol) —

    What type of subscription to add.

  • dead_letter_queue (AWSCDK::SQS::IQueue, nil) (defaults to: nil) —

    Queue to be used as dead letter queue.

  • delivery_policy (AWSCDK::SNS::DeliveryPolicy, nil) (defaults to: nil) —

    The delivery policy.

  • filter_policy (Hash{String => AWSCDK::SNS::SubscriptionFilter}, nil) (defaults to: nil) —

    The filter policy.

  • filter_policy_with_message_body (Hash{String => AWSCDK::SNS::FilterOrPolicy}, nil) (defaults to: nil) —

    The filter policy that is applied on the message body.

  • raw_message_delivery (Boolean, nil) (defaults to: nil) —

    true if raw message delivery is enabled for the subscription.

  • region (String, nil) (defaults to: nil) —

    The region where the topic resides, in the case of cross-region subscriptions.

  • subscription_role_arn (String, nil) (defaults to: nil) —

    Arn of role allowing access to firehose delivery stream.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'sns/subscription_options.rb', line 16

def initialize(endpoint:, protocol:, dead_letter_queue: nil, delivery_policy: nil, filter_policy: nil, filter_policy_with_message_body: nil, raw_message_delivery: nil, region: nil, subscription_role_arn: nil)
  @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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc25zLlN1YnNjcmlwdGlvblByb3RvY29sIn0=")), "protocol")
  @dead_letter_queue = dead_letter_queue
  Jsii::Type.check_type(@dead_letter_queue, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3FzLklRdWV1ZSJ9")), "deadLetterQueue") unless @dead_letter_queue.nil?
  @delivery_policy = delivery_policy.is_a?(Hash) ? ::AWSCDK::SNS::DeliveryPolicy.new(**delivery_policy.transform_keys(&:to_sym)) : delivery_policy
  Jsii::Type.check_type(@delivery_policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc25zLkRlbGl2ZXJ5UG9saWN5In0=")), "deliveryPolicy") unless @delivery_policy.nil?
  @filter_policy = filter_policy
  Jsii::Type.check_type(@filter_policy, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zbnMuU3Vic2NyaXB0aW9uRmlsdGVyIn0sImtpbmQiOiJtYXAifX0=")), "filterPolicy") unless @filter_policy.nil?
  @filter_policy_with_message_body = filter_policy_with_message_body
  Jsii::Type.check_type(@filter_policy_with_message_body, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zbnMuRmlsdGVyT3JQb2xpY3kifSwia2luZCI6Im1hcCJ9fQ==")), "filterPolicyWithMessageBody") unless @filter_policy_with_message_body.nil?
  @raw_message_delivery = raw_message_delivery
  Jsii::Type.check_type(@raw_message_delivery, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "rawMessageDelivery") unless @raw_message_delivery.nil?
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region") unless @region.nil?
  @subscription_role_arn = subscription_role_arn
  Jsii::Type.check_type(@subscription_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subscriptionRoleArn") unless @subscription_role_arn.nil?
end

Instance Attribute Details

#dead_letter_queue ⇒ AWSCDK::SQS::IQueue? (readonly)

Note:

Default: - No dead letter queue enabled.

Queue to be used as dead letter queue.

If not passed no dead letter queue is enabled.

Returns:



53
54
55
 
# File 'sns/subscription_options.rb', line 53

def dead_letter_queue
  @dead_letter_queue
end

#delivery_policy ⇒ AWSCDK::SNS::DeliveryPolicy? (readonly)

Note:

Default: - if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds

The delivery policy.

Returns:



58
59
60
 
# File 'sns/subscription_options.rb', line 58

def delivery_policy
  @delivery_policy
end

#endpoint ⇒ String (readonly)

The subscription endpoint.

The meaning of this value depends on the value for 'protocol'.

Returns:

  • (String) 


42
43
44
 
# File 'sns/subscription_options.rb', line 42

def endpoint
  @endpoint
end

#filter_policy ⇒ Hash{String => AWSCDK::SNS::SubscriptionFilter}? (readonly)

Note:

Default: - all messages are delivered

The filter policy.

Returns:



63
64
65
 
# File 'sns/subscription_options.rb', line 63

def filter_policy
  @filter_policy
end

#filter_policy_with_message_body ⇒ Hash{String => AWSCDK::SNS::FilterOrPolicy}? (readonly)

Note:

Default: - all messages are delivered

The filter policy that is applied on the message body.

To apply a filter policy to the message attributes, use filter_policy. A maximum of one of filter_policy_with_message_body and filter_policy may be used.

Returns:



70
71
72
 
# File 'sns/subscription_options.rb', line 70

def filter_policy_with_message_body
  @filter_policy_with_message_body
end

#protocol ⇒ AWSCDK::SNS::SubscriptionProtocol (readonly)

What type of subscription to add.

Returns:



46
47
48
 
# File 'sns/subscription_options.rb', line 46

def protocol
  @protocol
end

#raw_message_delivery ⇒ Boolean? (readonly)

Note:

Default: false

true if raw message delivery is enabled for the subscription.

Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints. For more information, see GetSubscriptionAttributes in the Amazon Simple Notification Service API Reference.

Returns:

  • (Boolean, nil) 


79
80
81
 
# File 'sns/subscription_options.rb', line 79

def raw_message_delivery
  @raw_message_delivery
end

#region ⇒ String? (readonly)

Note:

Default: - the region where the CloudFormation stack is being deployed.

The region where the topic resides, in the case of cross-region subscriptions.

Returns:

  • (String, nil) 


84
85
86
 
# File 'sns/subscription_options.rb', line 84

def region
  @region
end

#subscription_role_arn ⇒ String? (readonly)

Note:

Default: - No subscription role is provided

Arn of role allowing access to firehose delivery stream.

Required for a firehose subscription protocol.

Returns:

  • (String, nil) 


91
92
93
 
# File 'sns/subscription_options.rb', line 91

def subscription_role_arn
  @subscription_role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'sns/subscription_options.rb', line 93

def self.jsii_properties
  {
    :endpoint => "endpoint",
    :protocol => "protocol",
    :dead_letter_queue => "deadLetterQueue",
    :delivery_policy => "deliveryPolicy",
    :filter_policy => "filterPolicy",
    :filter_policy_with_message_body => "filterPolicyWithMessageBody",
    :raw_message_delivery => "rawMessageDelivery",
    :region => "region",
    :subscription_role_arn => "subscriptionRoleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'sns/subscription_options.rb', line 107

def to_jsii
  result = {}
  result.merge!({
    "endpoint" => @endpoint,
    "protocol" => @protocol,
    "deadLetterQueue" => @dead_letter_queue,
    "deliveryPolicy" => @delivery_policy,
    "filterPolicy" => @filter_policy,
    "filterPolicyWithMessageBody" => @filter_policy_with_message_body,
    "rawMessageDelivery" => @raw_message_delivery,
    "region" => @region,
    "subscriptionRoleArn" => @subscription_role_arn,
  })
  result.compact
end