[[etcd-keys-component]]
= Etcd Keys Component
//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
:page-source: components/camel-etcd/src/main/docs/etcd-keys-component.adoc
:docTitle: Etcd Keys
:artifactId: camel-etcd
:description: Get, set or delete keys in etcd key-value store.
:since: 2.18
:supportLevel: Stable
:component-header: Only producer is supported

*Since Camel {since}*

*{component-header}*

*Since Camel 2.18*


The camel Etcd component allows you to work with Etcd, a distributed reliable key-value store.

== URI Format

[source,java]
----------------------------
etcd-keys:path[?options]
----------------------------

== URI Options

// component options: START
The Etcd Keys component supports 12 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *configuration* (producer) | Component configuration. |  | EtcdConfiguration
| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *recursive* (producer) | To apply an action recursively. | false | boolean
| *servicePath* (producer) | The path to look for for service discovery | /services/ | String
| *timeout* (producer) | To set the maximum time an action could take to complete. |  | Long
| *uris* (common) | To set the URIs the client connects. | http://localhost:2379,http://localhost:4001 | String
| *timeToLive* (producer) | To set the lifespan of a key in milliseconds. |  | Integer
| *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *password* (security) | The password to use for basic authentication. |  | String
| *sslContextParameters* (security) | To configure security using SSLContextParameters. |  | SSLContextParameters
| *useGlobalSslContextParameters* (security) | Enable usage of global SSL context parameters. | false | boolean
| *userName* (security) | The user name to use for basic authentication. |  | String
|===
// component options: END

// endpoint options: START
The Etcd Keys endpoint is configured using URI syntax:

----
etcd-keys:path
----

with the following path and query parameters:

=== Path Parameters (1 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *path* | The path the endpoint refers to |  | String
|===


=== Query Parameters (11 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *recursive* (producer) | To apply an action recursively. | false | boolean
| *servicePath* (producer) | The path to look for for service discovery | /services/ | String
| *timeout* (producer) | To set the maximum time an action could take to complete. |  | Long
| *uris* (common) | To set the URIs the client connects. | http://localhost:2379,http://localhost:4001 | String
| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *timeToLive* (producer) | To set the lifespan of a key in milliseconds. |  | Integer
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
| *password* (security) | The password to use for basic authentication. |  | String
| *sslContextParameters* (security) | To configure security using SSLContextParameters. |  | SSLContextParameters
| *userName* (security) | The user name to use for basic authentication. |  | String
|===
// endpoint options: END
include::camel-spring-boot::page$etcd-starter.adoc[]
