Skip to main content

Amazon SQS

The Amazon SQS Transport is used to communicate to Amazon SQS. It is suitable for development, testing, and production environments.

Configuration​

To use the Amazon SQS Transport, define it under transports and reference it as current-transport.

Example​

current-transport: local-stack-amazon-sqs

transports:
  - name: local-stack-amazon-sqs
    amazonsqs-transport-config:
      region-name: us-east-1
      access-key: test
      secret-key: test
      service-url: http://127.0.0.1:32813/ # (optional) Only used when connecting to local-stack
info

The Amazon SQS transport implementation currently works only with AWS access key and secret key authentication. Pull requests that add support for additional authentication methods are welcome and greatly appreciated!

amazonsqs-transport-config Fields​

FieldRequiredTypeDefaultDescription
region-nameYesstring—The AWS region. All Region codes can be found here (EX: us-east-1, us-east2, us-west1..etc).
access-keyYesstring—The AWS Access Key.
secret-keyYesstring—The AWS Secret Key.
service-urlNostring—The service URL used to connect to LocalStack for local development.

s3-bucket-settings Fields​

FieldRequiredTypeDefaultDescription
bucket-nameyesstring—Name of the S3 bucket for storing large messages.
key-prefixyesstring—This is the path within the specified S3 bucket to store large messages.

Field Details​

region-name (required)​

The AWS Region SQS is hosted in.

Examples:

region-name: us-east-1

access-key (required)​

The AWS Access Key.

Examples:

access-key: test

secret-key (required)​

The AWS Secret Key.

Examples:

secret-key: test

service-url (optional)​

The service URL used to connect to LocalStack for local development.

Examples:

service-url: http://127.0.0.1:32813/

s3-bucket-settings (optional)​

Used to configure S3 bucket storage for large messages.

Examples:

s3-bucket-settings:
  bucket-name: nsb-sqs-messages
  key-prefix: my/sample/path