Skip to main content
Version: 0.8

SQS

Experimental
Creates:
AssetsLineage

Configure in the UI

This plugin can be configured directly in the Marmot UI with a step-by-step wizard.

View Guide

The SQS plugin discovers and catalogs Amazon SQS queues across your AWS accounts. It captures queue configurations and can discover Dead Letter Queue relationships.

Required Permissions​

AWS Configuration​

See AWS Configuration for the supported AWS configuration options.

Example Configuration​


credentials:
region: "us-east-1"
id: "<aws-secret-id>"
secret: "<aws-secret-key>"
tags:
- "sns"

Configuration​

The following configuration options are available:

PropertyTypeRequiredDescription
credentialsAWSCredentialsfalseAWS credentials configuration
discover_dlqboolfalseDiscover Dead Letter Queue relationships
external_links[]ExternalLinkfalseExternal links to show on all assets
filterFilterfalseFilter discovered assets by name (regex)
include_tags[]stringfalseList of AWS tags to include as metadata. By default, all tags are included.
tagsTagsConfigfalseTags to apply to discovered assets
tags_to_metadataboolfalseConvert AWS tags to Marmot metadata

Available Metadata​

The following metadata fields are available:

FieldTypeDescription
content_based_deduplicationboolWhether content-based deduplication is enabled
deduplication_scopestringDeduplication scope for FIFO queues
delay_secondsstringDelay seconds for messages
fifo_queueboolWhether this is a FIFO queue
fifo_throughput_limitstringFIFO throughput limit type
maximum_message_sizestringMaximum message size in bytes
message_retention_periodstringMessage retention period in seconds
queue_arnstringThe ARN of the SQS queue
receive_message_wait_timestringLong polling wait time in seconds
redrive_policystringRedrive policy JSON string
tagsmap[string]stringAWS resource tags
visibility_timeoutstringThe visibility timeout for the queue