:plugin: rackspace
:type: input
:default_codec: plain

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Rackspace input plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

Receives events from a Rackspace Cloud Queue service.

[id="plugins-{type}s-{plugin}-options"]
==== Rackspace Input Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-api_key>> |<<password,password>>|Yes
| <<plugins-{type}s-{plugin}-claim>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-queue>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-region>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-ttl>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-username>> |<<string,string>>|Yes
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
input plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-api_key"]
===== `api_key` 

  * This is a required setting.
  * Value type is <<password,password>>
  * There is no default value for this setting.

Rackspace Cloud API Key

[id="plugins-{type}s-{plugin}-claim"]
===== `claim` 

  * Value type is <<number,number>>
  * Default value is `1`

number of messages to claim
Min: 1, Max: 10

[id="plugins-{type}s-{plugin}-queue"]
===== `queue` 

  * Value type is <<string,string>>
  * Default value is `"logstash"`

Rackspace Queue Name

[id="plugins-{type}s-{plugin}-region"]
===== `region` 

  * Value type is <<string,string>>
  * Default value is `"dfw"`

Rackspace region
`ord, dfw, lon, syd,` etc

[id="plugins-{type}s-{plugin}-ttl"]
===== `ttl` 

  * Value type is <<number,number>>
  * Default value is `60`

length of time to hold claim
Min: 60

[id="plugins-{type}s-{plugin}-username"]
===== `username` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

Rackspace Cloud Username



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

:default_codec!: