Amazon Simple Queue Service (SQS)

Configuration Options

Required Options

queue_url(required)

The URL of the Amazon SQS queue to which messages are sent.

Type	Syntax	Default	Example
string	literal		["https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue"]

inputs(required)

A list of upstream source or transform IDs. Wildcards (*) are supported.

See configuration for more info.

Type	Syntax	Default	Example
array	literal		["my-source-or-transform-id","prefix-*"]

encoding(required)

Configures the encoding specific sink behavior.

Type	Syntax	Default	Example
hash	literal		[]

region(required)

The AWS region of the target service. If endpoint is provided it will override this value since the endpoint includes the region.

Type	Syntax	Default	Example
string	literal		["us-east-1"]

type(required)

The component type. This is a required field for all components and tells Vector which component to use.

Type	Syntax	Default	Example
string	literal		["aws_sqs"]

Advanced Options

auth(optional)

Options for the authentication strategy.

Type	Syntax	Default	Example
hash	literal		[]

endpoint(optional)

Custom endpoint for use with AWS-compatible services. Providing a value for this option will make region moot.

Type	Syntax	Default	Example
string	literal		["127.0.0.0:5000/path/to/service"]

message_group_id(optional)

The tag that specifies that a message belongs to a specific message group. Can be applied only to FIFO queues.

Type	Syntax	Default	Example
string	template		["vector","vector-%Y-%m-%d"]

buffer(optional)

Configures the sink specific buffer behavior.

Type	Syntax	Default	Example
hash	literal		[]

healthcheck(optional)

Health check options for the sink.

Type	Syntax	Default	Example
hash			[]

request(optional)

Configures the sink request behavior.

Type	Syntax	Default	Example
hash			[]

proxy(optional)

Configures an HTTP(S) proxy for Vector to use. By default, the globally configured proxy is used.

Type	Syntax	Default	Example
hash	literal		[]

message_deduplication_id(optional)

The message deduplication ID value to allow AWS to identify duplicate messages. This value is a template which should result in a unique string for each event.

See the AWS documentation for more about how AWS does message deduplication.

Type	Syntax	Default	Example
string	template		["{{ transaction_id }}"]

How it Works

AWS authentication

Vector checks for AWS credentials in the following order:

The access_key_id and secret_access_key options.
The AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.
The credential_process command in the AWS config file (usually located at ~/.aws/config).
The AWS credentials file (usually located at ~/.aws/credentials).
The IAM instance profile (only works if running on an EC2 instance with an instance profile/role).

If no credentials are found, Vector's health check fails and an error is logged. If your AWS credentials expire, Vector will automatically search for up-to-date credentials in the places (and order) described above.

State

This component is stateless, meaning its behavior is consistent across each input.

Health checks

Health checks ensure that the downstream service is accessible and ready to accept data. This check is performed upon sink initialization. If the health check fails an error will be logged and Vector will proceed to start.

Partitioning

Vector supports dynamic configuration values through a simple template syntax. If an option supports templating, it will be noted with a badge and you can use event fields to create dynamic values. For example:

[sinks.my-sink]
dynamic_option = "application={{ application_id }}"

In the above example, the application_id for each event will be used to partition outgoing data.

Rate limits & adapative concurrency

Retry policy

Vector will retry failed requests (status == 429, >= 500, and != 501). Other responses will not be retried. You can control the number of retry attempts and backoff rate with the request.retry_attempts and request.retry_backoff_secs options.