You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SQS::Resource

Inherits:
Resources::Resource show all
Defined in:
(unknown)

Overview

This class provides a resource oriented interface for Amazon SQS. To create a resource object:

resource = Aws::SQS::Resource.new

You can supply a client object with custom configuration that will be used for all resource operations. If you do not pass :client, a default client will be constructed.

client = Aws::SQS::Client.new(region: 'us-west-2')
resource = Aws::SQS::Resource.new(client: client)

Resource Resource Classes

Aws::SQS::Resource has the following resource classes:

Instance Attribute Summary

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Method Details

#create_queue(options = {}) ⇒ Queue

Examples:

Request syntax example with placeholder values


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

Basic usage

queue = sqs.create_queue(options)
queue.url
#=> "queue-url"

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 as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues 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.

      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.

    • 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 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. If you don\'t specify the FifoQueue attribute, Amazon SQS creates a standard queue. 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 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.

  • :tags (Hash<String,String>) —

    Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    When you use queue tags, keep the following guidelines in mind:

    • Adding more than 50 tags to a queue isn\'t recommended.

    • Tags don\'t have any semantic meaning. Amazon SQS interprets tags as character strings.

    • Tags are case-sensitive.

    • A new tag with a key identical to that of an existing tag overwrites the existing tag.

    For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

    To be able to tag a queue on creation, you must have the sqs:CreateQueue and sqs:TagQueue permissions.

    Cross-account permissions don\'t apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

Returns:

See Also:

#get_queue_by_name(options = {}) ⇒ Queue

Examples:

Request syntax example with placeholder values


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

Basic usage

queue = sqs.get_queue_by_name(options)
queue.url
#=> "queue-url"

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:

See Also:

#queue(url) ⇒ Queue

Parameters:

Returns:

See Also:

#queues(options = {}) ⇒ Collection<Queue>

Returns a Collection of Queue resources. No API requests are made until you call an enumerable method on the collection. Client#list_queues will be called multiple times until every Queue has been yielded.

Examples:

Request syntax example with placeholder values


sqs.queues({
  queue_name_prefix: "String",
  next_token: "Token",
  max_results: 1,
})

Enumerating Queue resources.

sqs.queues.each do |queue|
  # yields each queue
end

Enumerating Queue resources with a limit.

sqs.queues.limit(10).each do |queue|
  # yields at most 10 queues
end

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.

  • :next_token (String) —

    Pagination token to request the next set of results.

  • :max_results (Integer) —

    Maximum number of results to include in the response. Value range is 1 to 1000. You must set MaxResults to receive a value for NextToken in the response.

Returns:

See Also: