.. _sqs_configuration_options:

Configuration Properties
------------------------

To use this connector, specify the name of the connector class in the ``connector.class`` configuration property.

.. codewithvars:: properties

    connector.class=io.confluent.connect.sqs.source.SqsSourceConnector

Connector-specific configuration properties are described below.


Kafka
^^^^^

``kafka.topic``
  The name of |ak| topic to publish data to. Only a single topic must be specified. Records from one or more |aws| SQS queues will be published to this topic.

  * Type: string
  * Importance: high

SQS
^^^

``sqs.url``
  Fully qualified |aws| SQS URL from which this source connector polls messages.

  * Type: string
  * Valid Values: Fully qualified HTTPS URL in the format https://sqs.us-east-1.amazonaws.com/909887982971/sqs-fifo-queue.fifo.
  * Importance: high

``sqs.credentials.provider.class``
  Credentials provider or provider chain to use for authentication to |aws|. By default the connector uses ``DefaultAWSCredentialsProviderChain``.

  * Type: class
  * Default: com.amazonaws.auth.DefaultAWSCredentialsProviderChain
  * Valid Values: Any class implementing: interface com.amazonaws.auth.AWSCredentialsProvider
  * Importance: low

``sqs.proxy.url``
  HTTPS Proxy Server URL. This property is meant to be used only if you need to access SQS through an HTTPS proxy.

  * Type: string
  * Default: ""
  * Importance: low

``sqs.proxy.user``
  HTTPS Proxy User. This property is meant to be used only if you need to access SQS through a proxy. Using ``sqs.proxy.user`` instead of embedding the username and password in ``sqs.proxy.url`` allows the password to be hidden in the logs.

  * Type: string
  * Default: null
  * Importance: low

``sqs.proxy.password``
  HTTPS Proxy Password. This property is meant to be used only if you need to access SQS through a proxy. Using ``sqs.proxy.password`` instead of embedding the username and password in ``sqs.proxy.url`` allows the password to be hidden in the logs.

  * Type: password
  * Default: [hidden]
  * Importance: low

``sqs.messages.max``
  SQS max number of messages to poll. The maximum number of messages to read from SQS in every poll. |aws| SQS never returns more messages than this value (however, fewer messages might be returned).

  * Type: int
  * Default: 10
  * Valid Values: [0,...,10]
  * Importance: low

``sqs.waittime.seconds``
  The duration (in seconds) that the call to SQS waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.

  * Type: int
  * Default: 20
  * Valid Values: [0,...,20]
  * Importance: low

``sqs.max.retries``
  Max number of retry attempts. In case of a network error, the connector can automatically retry the connection.

  * Type: int
  * Default: 3
  * Valid Values: [0,...,10]
  * Importance: low

.. _sqs-source-connector-license-config:

|cp| license
^^^^^^^^^^^^

``confluent.topic.bootstrap.servers``
 A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the form <code>host1:port1,host2:port2,...</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).

 * Type: list
 * Importance: high

``confluent.topic``
 Name of the Kafka topic used for Confluent Platform configuration, including licensing information.

 * Type: string
 * Default: _confluent-command
 * Importance: low

``confluent.topic.replication.factor``
 The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1).

 * Type: int
 * Default: 3
 * Importance: low

----------------------------
Confluent license properties
----------------------------

.. include:: ../includes/security-info.rst

.. include:: ../includes/platform-license.rst

.. include:: ../includes/security-configs.rst

.. _sqs_license-topic-configuration:

.. include:: ../includes/platform-license-detail.rst

.. include:: ../includes/overriding-default-config-properties.rst