queue

Gets an individual queue resource

Overview

Name	queue
Type	Resource
Description	queue
Id	awscc.sqs.queue

Fields

Name	Datatype	Description
queue_url	string	URL of the source queue.
arn	string	Amazon Resource Name (ARN) of the queue.
content_based_deduplication	boolean	For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message.
deduplication_scope	string	Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.
delay_seconds	integer	The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.
fifo_queue	boolean	If set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue.
fifo_throughput_limit	string	Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
kms_data_key_reuse_period_seconds	integer	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. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
kms_master_key_id	string	The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs.
sqs_managed_sse_enabled	boolean	Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).
maximum_message_size	integer	The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).
message_retention_period	integer	The number of seconds that Amazon SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).
queue_name	string	A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix.
receive_message_wait_time_seconds	integer	Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property.
redrive_allow_policy	object	The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object.
redrive_policy	object	A string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue.
tags	array	The tags that you attach to this queue.
visibility_timeout	integer	The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
queue_url,
arn,
content_based_deduplication,
deduplication_scope,
delay_seconds,
fifo_queue,
fifo_throughput_limit,
kms_data_key_reuse_period_seconds,
kms_master_key_id,
sqs_managed_sse_enabled,
maximum_message_size,
message_retention_period,
queue_name,
receive_message_wait_time_seconds,
redrive_allow_policy,
redrive_policy,
tags,
visibility_timeout
FROM awscc.sqs.queue
WHERE data__Identifier = '<QueueUrl>';

Permissions

To operate on the queue resource, the following permissions are required:

Read

sqs:GetQueueAttributes,
sqs:ListQueueTags

Update

sqs:SetQueueAttributes,
sqs:GetQueueAttributes,
sqs:ListQueueTags,
sqs:TagQueue,
sqs:UntagQueue

Delete

sqs:DeleteQueue,
sqs:GetQueueAttributes