The tap-amazon-sqs
extractor
pulls data from
Amazon SQS that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-amazon-sqs extractor to your
project using
:meltano add -
Configure the tap-amazon-sqs
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-amazon-sqsmeltano config tap-amazon-sqs set --interactivemeltano config tap-amazon-sqs testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-amazon-sqs
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-amazon-sqs settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
airbyte_config.access_keyairbyte_config.attributes_to_returnairbyte_config.delete_messagesairbyte_config.max_batch_sizeairbyte_config.max_wait_timeairbyte_config.queue_urlairbyte_config.regionairbyte_config.secret_keyairbyte_config.visibility_timeoutairbyte_spec.imageairbyte_spec.tagdocker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-amazon-sqs list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Airbyte Config Access Key (airbyte_config.access_key)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_CONFIG_ACCESS_KEY
The Access Key ID of the AWS IAM Role to use for pulling messages
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_config access_key [value]Airbyte Config Attributes To Return (airbyte_config.attributes_to_return)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_CONFIG_ATTRIBUTES_TO_RETURN
Comma separated list of Mesage Attribute names to return
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_config attributes_to_return [value]Airbyte Config Delete Messages (airbyte_config.delete_messages)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_CONFIG_DELETE_MESSAGES
If Enabled, messages will be deleted from the SQS Queue after being read. If Disabled, messages are left in the queue and can be read more than once. WARNING: Enabling this option can result in data loss in cases of failure, use with caution, see documentation for more detail.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_config delete_messages [value]Airbyte Config Max Batch Size (airbyte_config.max_batch_size)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_CONFIG_MAX_BATCH_SIZE
Max amount of messages to get in one batch (10 max)
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_config max_batch_size [value]Airbyte Config Max Wait Time (airbyte_config.max_wait_time)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_CONFIG_MAX_WAIT_TIME
Max amount of time in seconds to wait for messages in a single poll (20 max)
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_config max_wait_time [value]Airbyte Config Queue Url (airbyte_config.queue_url)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_CONFIG_QUEUE_URL
URL of the SQS Queue
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_config queue_url [value]Airbyte Config Region (airbyte_config.region)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_CONFIG_REGION
AWS Region of the SQS Queue
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_config region [value]Airbyte Config Secret Key (airbyte_config.secret_key)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_CONFIG_SECRET_KEY
The Secret Key of the AWS IAM Role to use for pulling messages
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_config secret_key [value]Airbyte Config Visibility Timeout (airbyte_config.visibility_timeout)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_CONFIG_VISIBILITY_TIMEOUT
Modify the Visibility Timeout of the individual message from the Queue's default (seconds).
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_config visibility_timeout [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-amazon-sqs
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_AMAZON_SQS_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_AMAZON_SQS_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_AMAZON_SQS_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_AMAZON_SQS_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_AMAZON_SQS_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_AMAZON_SQS_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-amazon-sqs set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-yellow){kind=icon}
-1-c0c0c4){kind=icon}
