Class: AWSCDK::SQS::RedriveAllowPolicy

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sqs/redrive_allow_policy.rb

Overview

Permission settings for the dead letter source queue.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(redrive_permission: nil, source_queues: nil) ⇒ RedriveAllowPolicy

Returns a new instance of RedriveAllowPolicy.

Parameters:

  • redrive_permission (AWSCDK::SQS::RedrivePermission, nil) (defaults to: nil) —

    Permission settings for source queues that can designate this queue as their dead-letter queue.

  • source_queues (Array<AWSCDK::SQS::IQueue>, nil) (defaults to: nil) —

    Source queues that can designate this queue as their dead-letter queue.



9
10
11
12
13
14
 
# File 'sqs/redrive_allow_policy.rb', line 9

def initialize(redrive_permission: nil, source_queues: nil)
  @redrive_permission = redrive_permission
  Jsii::Type.check_type(@redrive_permission, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3FzLlJlZHJpdmVQZXJtaXNzaW9uIn0=")), "redrivePermission") unless @redrive_permission.nil?
  @source_queues = source_queues
  Jsii::Type.check_type(@source_queues, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zcXMuSVF1ZXVlIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "sourceQueues") unless @source_queues.nil?
end

Instance Attribute Details

#redrive_permission ⇒ AWSCDK::SQS::RedrivePermission? (readonly)

Note:

Default: - RedrivePermission.BY_QUEUE if sourceQueues is specified,RedrivePermission.ALLOW_ALL otherwise.

Permission settings for source queues that can designate this queue as their dead-letter queue.

Returns:



20
21
22
 
# File 'sqs/redrive_allow_policy.rb', line 20

def redrive_permission
  @redrive_permission
end

#source_queues ⇒ Array<AWSCDK::SQS::IQueue>? (readonly)

Note:

Default: - Required when redrivePermission is RedrivePermission.BY_QUEUE, cannot be defined otherwise.

Source queues that can designate this queue as their dead-letter queue.

When redrive_permission is set to RedrivePermission.BY_QUEUE, this parameter is required.

You can specify up to 10 source queues. To allow more than 10 source queues to specify dead-letter queues, set the redrive_permission to RedrivePermission.ALLOW_ALL.

When redrive_permission is either RedrivePermission.ALLOW_ALL or RedrivePermission.DENY_ALL, this parameter cannot be set.

Returns:



34
35
36
 
# File 'sqs/redrive_allow_policy.rb', line 34

def source_queues
  @source_queues
end

Class Method Details

.jsii_properties ⇒ Object 



36
37
38
39
40
41
 
# File 'sqs/redrive_allow_policy.rb', line 36

def self.jsii_properties
  {
    :redrive_permission => "redrivePermission",
    :source_queues => "sourceQueues",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



43
44
45
46
47
48
49
50
 
# File 'sqs/redrive_allow_policy.rb', line 43

def to_jsii
  result = {}
  result.merge!({
    "redrivePermission" => @redrive_permission,
    "sourceQueues" => @source_queues,
  })
  result.compact
end