aws_sqs

Type:

Available in: Cloud, Self-Managed

Consume messages from an AWS SQS URL.

  • Common

  • Advanced

inputs:
  label: ""
  aws_sqs:
    url: "" # No default (required)
    max_outstanding_messages: 1000
inputs:
  label: ""
  aws_sqs:
    url: "" # No default (required)
    delete_message: true
    reset_visibility: true
    max_number_of_messages: 10
    max_outstanding_messages: 1000
    wait_time_seconds: 0
    message_timeout: 30s
    region: "" # No default (optional)
    endpoint: "" # No default (optional)
    tcp:
      connect_timeout: 0s
      keep_alive:
        idle: 15s
        interval: 15s
        count: 9
      tcp_user_timeout: 0s
    credentials:
      profile: "" # No default (optional)
      id: "" # No default (optional)
      secret: "" # No default (optional)
      token: "" # No default (optional)
      from_ec2_role: "" # No default (optional)
      role: "" # No default (optional)
      role_external_id: "" # No default (optional)

Credentials

By default, Redpanda Connect uses a shared credentials file when connecting to AWS services. You can also set credentials explicitly at the component level, which allows you to transfer data across accounts. To find out more, see Amazon Web Services.

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

credentials

Optional manual configuration of AWS credentials to use. More information can be found in Amazon Web Services.

Type: object

credentials.from_ec2_role

Use the credentials of a host EC2 machine configured to assume an IAM role associated with the instance.

Type: bool

credentials.id

The ID of credentials to use.

Type: string

credentials.profile

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

Type: string

credentials.role

A role ARN to assume.

Type: string

credentials.role_external_id

An external ID to provide when assuming a role.

Type: string

credentials.secret

The secret for the credentials being used.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration.

Type: string

credentials.token

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

Type: string

delete_message

Whether to delete the consumed message when it’s acknowledged. Set to false to handle the deletion using a different mechanism.

Type: bool

Default: true

endpoint

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

Type: string

max_number_of_messages

The maximum number of messages that Redpanda Connect can return each time it polls the SQS URL. Enter values from 1 to 10 only.

Type: int

Default: 10

max_outstanding_messages

The maximum number of pending messages that Redpanda Connect can have in flight at the same time.

Type: int

Default: 1000

message_timeout

The maximum time allowed to process a received message before Redpanda Connect refreshes the receipt handle, and the message becomes visible in the queue again. Redpanda Connect attempts to refresh the receipt handle after half of the timeout has elapsed.

Type: string

Default: 30s

region

The AWS region to target.

Type: string

reset_visibility

Whether to set the visibility timeout of the consumed message to zero if Redpanda Connect receives a negative acknowledgement. Set to false to use the queue’s visibility timeout for each message rather than releasing the message immediately for reprocessing.

Type: bool

Default: true

tcp

Configure TCP socket-level settings to optimize network performance and reliability. These low-level controls are useful for:

  • High-latency networks: Increase connect_timeout to allow more time for connection establishment

  • Long-lived connections: Configure keep_alive settings to detect and recover from stale connections

  • Unstable networks: Tune keep-alive probes to balance between quick failure detection and avoiding false positives

  • Linux systems with specific requirements: Use tcp_user_timeout (Linux 2.6.37+) to control data acknowledgment timeouts

Most users should keep the default values. Only modify these settings if you’re experiencing connection stability issues or have specific network requirements.

Type: object

tcp.connect_timeout

Maximum amount of time a dial will wait for a connect to complete. Zero disables.

Type: string

Default: 0s

tcp.keep_alive

TCP keep-alive probe configuration.

Type: object

tcp.keep_alive.count

Maximum unanswered keep-alive probes before dropping the connection. Zero defaults to 9.

Type: int

Default: 9

tcp.keep_alive.idle

Duration the connection must be idle before sending the first keep-alive probe. Zero defaults to 15s. Negative values disable keep-alive probes.

Type: string

Default: 15s

tcp.keep_alive.interval

Duration between keep-alive probes. Zero defaults to 15s.

Type: string

Default: 15s

tcp.tcp_user_timeout

Maximum time to wait for acknowledgment of transmitted data before killing the connection. Linux-only (kernel 2.6.37+), ignored on other platforms. When enabled, keep_alive.idle must be greater than this value per RFC 5482. Zero disables.

Type: string

Default: 0s

url

The SQS URL to consume from.

Type: string

wait_time_seconds

Whether to set a wait time (in seconds). Enter values from 1 to 20 to enable wait times and to activate log polling for queued messages.

Type: int

Default: 0