Skip to main content

sqs

DEPRECATED

This component is deprecated and will be removed in the next major version release. Please consider moving onto alternative components.

Receive messages from an Amazon SQS URL.

# Common config fields, showing default values
input:
  label: ""
  sqs:
    url: ""
    region: eu-west-1

Alternatives​

This input is being replaced with the shiny new aws_sqs input, which has improved features, consider trying it out instead.

Credentials​

By default Benthos will use a shared credentials file when connecting to AWS services. It's also possible to set them explicitly at the component level, allowing you to transfer data across accounts. You can find out more in this document.

Metadata​

This input adds the following metadata fields to each message:

- sqs_message_id
- sqs_receipt_handle
- sqs_approximate_receive_count
- All message attributes

You can access these metadata fields using function interpolation.

Fields​

url​

The SQS URL to consume from.

Type: string
Default: ""

delete_message​

Whether to delete the consumed message once it is acked. Disabling allows you to handle the deletion using a different mechanism.

Type: bool
Default: true

region​

The AWS region to target.

Type: string
Default: "eu-west-1"

endpoint​

Allows you to specify a custom endpoint for the AWS API.

Type: string
Default: ""

credentials​

Optional manual configuration of AWS credentials to use. More information can be found in this document.

Type: object

credentials.profile​

A profile from ~/.aws/credentials to use.

Type: string
Default: ""

credentials.id​

The ID of credentials to use.

Type: string
Default: ""

credentials.secret​

The secret for the credentials being used.

Type: string
Default: ""

credentials.token​

The token for the credentials being used, required when using short term credentials.

Type: string
Default: ""

credentials.role​

A role ARN to assume.

Type: string
Default: ""

credentials.role_external_id​

An external ID to provide when assuming a role.

Type: string
Default: ""

timeout​

The period of time to wait before abandoning a request and trying again.

Type: string
Default: "5s"

max_number_of_messages​

The maximum number of messages to consume from each request.

Type: int
Default: 1