Class: AWSCDK::SNSSubscriptions::SubscriptionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sns_subscriptions/subscription_props.rb

Overview

Options to subscribing to an SNS topic.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dead_letter_queue: nil, filter_policy: nil, filter_policy_with_message_body: nil) ⇒ SubscriptionProps

Returns a new instance of SubscriptionProps.

Parameters:



10
11
12
13
14
15
16
17
 
# File 'sns_subscriptions/subscription_props.rb', line 10

def initialize(dead_letter_queue: nil, filter_policy: nil, filter_policy_with_message_body: nil)
  @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?
  @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?
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:



25
26
27
 
# File 'sns_subscriptions/subscription_props.rb', line 25

def dead_letter_queue
  @dead_letter_queue
end

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

Note:

Default: - all messages are delivered

The filter policy.

Returns:



30
31
32
 
# File 'sns_subscriptions/subscription_props.rb', line 30

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:



37
38
39
 
# File 'sns_subscriptions/subscription_props.rb', line 37

def filter_policy_with_message_body
  @filter_policy_with_message_body
end

Class Method Details

.jsii_properties ⇒ Object 



39
40
41
42
43
44
45
 
# File 'sns_subscriptions/subscription_props.rb', line 39

def self.jsii_properties
  {
    :dead_letter_queue => "deadLetterQueue",
    :filter_policy => "filterPolicy",
    :filter_policy_with_message_body => "filterPolicyWithMessageBody",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



47
48
49
50
51
52
53
54
55
 
# File 'sns_subscriptions/subscription_props.rb', line 47

def to_jsii
  result = {}
  result.merge!({
    "deadLetterQueue" => @dead_letter_queue,
    "filterPolicy" => @filter_policy,
    "filterPolicyWithMessageBody" => @filter_policy_with_message_body,
  })
  result.compact
end