queue_attributes

Creates, updates, deletes, gets or lists a queue_attributes resource.

Overview

Name	queue_attributes
Type	Resource
Id	aws.sqs.queue_attributes

Fields

The following fields are returned by SELECT queries:

get_queue_attributes

Name	Datatype	Description
attributes	object	A map of attributes to their respective values.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_queue_attributes	select	region		Gets attributes for the specified queue. To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
set_queue_attributes	update	region, QueueUrl		Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_queue_attributes

Gets attributes for the specified queue. To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

SELECT
attributes
FROM aws.sqs.queue_attributes
WHERE region = '{{ region }}' -- required
;

UPDATE examples

set_queue_attributes

Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

UPDATE aws.sqs.queue_attributes
SET 
QueueUrl = '{{ QueueUrl }}',
Attributes = '{{ Attributes }}'
WHERE 
region = '{{ region }}' --required
AND QueueUrl = '{{ QueueUrl }}' --required;