Class: Aws::SQS::Resource

Inherits:

Object

Object
Aws::SQS::Resource

show all

Defined in:: lib/aws-sdk-sqs/resource.rb

Actions collapse

Associations collapse

Instance Method Summary collapse

#client ⇒ Client
#initialize(options = {}) ⇒ Resource constructor

A new instance of Resource.

Constructor Details

#initialize(options = {}) ⇒ `Resource`

Returns a new instance of Resource.

Parameters:

options ({}) (defaults to: {})

Options Hash (options):

:client (Client)



13
14
15

# File 'lib/aws-sdk-sqs/resource.rb', line 13

def initialize(options = {})
  @client = options[:client] || Client.new(options)
end

Instance Method Details

#client ⇒ `Client`

Returns:

(Client)



18
19
20

# File 'lib/aws-sdk-sqs/resource.rb', line 18

def client
  @client
end

#create_queue(options = {}) ⇒ `Queue`

Examples:

Request syntax with placeholder values


queue = sqs.create_queue({
  queue_name: "String", # required
  attributes: {
    "All" => "String",
  },
})

Parameters:

options (Hash) (defaults to: {}) —

({})

Options Hash (options):

:queue_name (required, String) —
The name of the new queue. The following limits apply to this name:
- A queue name can have up to 80 characters.
- Valid values: alphanumeric characters, hyphens (‘-`), and underscores (`_`).
- A FIFO queue name must end with the ‘.fifo` suffix.
Queue URLs and names are case-sensitive.
:attributes (Hash<String,String>) —
A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the ‘CreateQueue` action uses:
- ‘DelaySeconds` - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
- ‘MaximumMessageSize` - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
- ‘MessageRetentionPeriod` - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).
- ‘Policy` - The queue’s policy. A valid AWS policy. For more information about policy structure, see [Overview of AWS IAM Policies] in the *Amazon IAM User Guide*.
- ‘ReceiveMessageWaitTimeSeconds` - The length of time, in seconds, for which a ` ReceiveMessage ` action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
- ‘RedrivePolicy` - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see
  
  Using Amazon SQS Dead-Letter Queues][2
  
  in the *Amazon Simple Queue
  
  Service Developer Guide*.
  - ‘deadLetterTargetArn` - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of `maxReceiveCount` is exceeded.
  - ‘maxReceiveCount` - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the `ReceiveCount` for a message exceeds the `maxReceiveCount` for a queue, Amazon SQS moves the message to the dead-letter-queue.
  <note markdown=“1”> The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
```
</note>
```
- ‘VisibilityTimeout` - The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see
  
  Visibility Timeout][3
  
  in the *Amazon Simple Queue Service
  
  Developer Guide*.
The following attributes apply only to [server-side-encryption]:
- ‘KmsMasterKeyId` - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see [Key Terms]. While the alias of the AWS-managed CMK for Amazon SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for example, be `alias/MyAlias `. For more examples, see [KeyId] in the *AWS Key Management Service API Reference*.
- ‘KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for which Amazon SQS can reuse a [data key] to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see [How Does the Data Key Reuse Period Work?].
The following attributes apply only to [FIFO (first-in-first-out) queues]:
- ‘FifoQueue` - Designates a queue as FIFO. Valid values: `true`, `false`. You can provide this attribute only during queue creation. You can’t change it for an existing queue. When you set this attribute, you must also provide the ‘MessageGroupId` for your messages explicitly.
  
  For more information, see [FIFO Queue Logic] in the *Amazon Simple Queue Service Developer Guide*.
- ‘ContentBasedDeduplication` - Enables content-based deduplication. Valid values: `true`, `false`. For more information, see
  
  Exactly-Once Processing][11
  
  in the *Amazon Simple Queue Service
  
  Developer Guide*.
  - Every message must have a unique ‘MessageDeduplicationId`,
    - You may provide a ‘MessageDeduplicationId` explicitly.
    - If you aren’t able to provide a ‘MessageDeduplicationId` and you enable `ContentBasedDeduplication` for your queue, Amazon SQS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).
    - If you don’t provide a ‘MessageDeduplicationId` and the queue doesn’t have ‘ContentBasedDeduplication` set, the action fails with an error.
    - If the queue has ‘ContentBasedDeduplication` set, your `MessageDeduplicationId` overrides the generated one.
  - When ‘ContentBasedDeduplication` is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
  - If you send one message with ‘ContentBasedDeduplication` enabled and then another message with a `MessageDeduplicationId` that is the same as the one generated for the first `MessageDeduplicationId`, the two messages are treated as duplicates and only one copy of the message is delivered.
[1]: docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html [3]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html [4]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html [5]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms [6]: docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters [7]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys [8]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work [9]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html [10]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic [11]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing

Returns:

(Queue)

# File 'lib/aws-sdk-sqs/resource.rb', line 176

def create_queue(options = {})
  resp = @client.create_queue(options)
  Queue.new(
    url: resp.data.queue_url,
    client: @client
  )
end

#get_queue_by_name(options = {}) ⇒ `Queue`

Examples:

Request syntax with placeholder values


queue = sqs.get_queue_by_name({
  queue_name: "String", # required
  queue_owner_aws_account_id: "String",
})

Parameters:

options (Hash) (defaults to: {}) —

({})

Options Hash (options):

:queue_name (required, String) —

The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (‘-`), and underscores (`_`).

Queue URLs and names are case-sensitive.
:queue_owner_aws_account_id (String) —

The AWS account ID of the account that created the queue.

Returns:

(Queue)

# File 'lib/aws-sdk-sqs/resource.rb', line 200

def get_queue_by_name(options = {})
  resp = @client.get_queue_url(options)
  Queue.new(
    url: resp.data.queue_url,
    client: @client
  )
end

#queue(url) ⇒ `Queue`

Parameters:

url (String)

Returns:

(Queue)

# File 'lib/aws-sdk-sqs/resource.rb', line 212

def queue(url)
  Queue.new(
    url: url,
    client: @client
  )
end

#queues(options = {}) ⇒ `Queue::Collection`

Examples:

Request syntax with placeholder values


queues = sqs.queues({
  queue_name_prefix: "String",
})

Parameters:

options (Hash) (defaults to: {}) —

({})

Options Hash (options):

:queue_name_prefix (String) —

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Returns:

(Queue::Collection)

# File 'lib/aws-sdk-sqs/resource.rb', line 231

def queues(options = {})
  batches = Enumerator.new do |y|
    batch = []
    resp = @client.list_queues(options)
    resp.data.queue_urls.each do |q|
      batch << Queue.new(
        url: q,
        client: @client
      )
    end
    y.yield(batch)
  end
  Queue::Collection.new(batches)
end

Class: Aws::SQS::Resource

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Resource

Instance Method Details

#client ⇒ Client

#create_queue(options = {}) ⇒ Queue

#get_queue_by_name(options = {}) ⇒ Queue

#queue(url) ⇒ Queue

#queues(options = {}) ⇒ Queue::Collection

#initialize(options = {}) ⇒ `Resource`

#client ⇒ `Client`

#create_queue(options = {}) ⇒ `Queue`

#get_queue_by_name(options = {}) ⇒ `Queue`

#queue(url) ⇒ `Queue`

#queues(options = {}) ⇒ `Queue::Collection`