Skip to content

Add documentation about GetQueueUrl and DSN format in SQS transport #14517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2020
Merged

Add documentation about GetQueueUrl and DSN format in SQS transport #14517

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions messenger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1300,7 +1300,7 @@ Amazon SQS

.. versionadded:: 5.1

The Amazon SQS transport as introduced in Symfony 5.1.
The Amazon SQS transport has been introduced in Symfony 5.1.

The Amazon SQS transport is perfect for application hosted on AWS. Install it by
running:
Expand All @@ -1314,14 +1314,25 @@ The SQS transport DSN may looks like this:
.. code-block:: env

# .env
MESSENGER_TRANSPORT_DSN=sqs://AKIAIOSFODNN7EXAMPLE:[email protected]/messages
MESSENGER_TRANSPORT_DSN=https://AKIAIOSFODNN7EXAMPLE:[email protected]/123456789012/messages
MESSENGER_TRANSPORT_DSN=sqs://localhost:9494/messages?sslmode=disable

.. note::

The transport will automatically create queues that are needed. This
can be disabled setting the ``auto_setup`` option to ``false``.

.. tip::

Before sending or receiving a message, Symfony needs to convert the queue
name into an AWS queue URL by calling the ``GetQueueUrl`` API in AWS. This
extra API call can be avoided by providing a DSN which is the queue URL.

.. versionadded:: 5.2

Providing a DSN equals to the queue URL to avoid call to ``GetQueueUrl``
has been introduced in Symfony 5.2.

The transport has a number of options:

====================== ====================================== ===================================
Expand Down