docs/index.asciidoc in logstash-input-sqs-3.0.6 vs docs/index.asciidoc in logstash-input-sqs-3.1.0

- old
+ new

@@ -55,15 +55,16 @@ "Statement": [ { "Action": [ "sqs:ChangeMessageVisibility", "sqs:ChangeMessageVisibilityBatch", + "sqs:DeleteMessage", + "sqs:DeleteMessageBatch", "sqs:GetQueueAttributes", "sqs:GetQueueUrl", "sqs:ListQueues", - "sqs:SendMessage", - "sqs:SendMessageBatch" + "sqs:ReceiveMessage" ], "Effect": "Allow", "Resource": [ "arn:aws:sqs:us-east-1:123456789012:Logstash" ] @@ -82,16 +83,19 @@ [cols="<,<,<",options="header",] |======================================================================= |Setting |Input type|Required | <<plugins-{type}s-{plugin}-access_key_id>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-aws_credentials_file>> |<<string,string>>|No +| <<plugins-{type}s-{plugin}-endpoint>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-id_field>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-md5_field>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-polling_frequency>> |<<number,number>>|No | <<plugins-{type}s-{plugin}-proxy_uri>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-queue>> |<<string,string>>|Yes -| <<plugins-{type}s-{plugin}-region>> |<<string,string>>, one of `["us-east-1", "us-east-2", "us-west-1", "us-west-2", "eu-central-1", "eu-west-1", "eu-west-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2", "sa-east-1", "us-gov-west-1", "cn-north-1", "ap-south-1", "ca-central-1"]`|No +| <<plugins-{type}s-{plugin}-region>> |<<string,string>>|No +| <<plugins-{type}s-{plugin}-role_arn>> |<<string,string>>|No +| <<plugins-{type}s-{plugin}-role_session_name>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-secret_access_key>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-sent_timestamp_field>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-session_token>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-threads>> |<<number,number>>|No |======================================================================= @@ -130,11 +134,20 @@ ---------------------------------- :access_key_id: "12345" :secret_access_key: "54321" ---------------------------------- +[id="plugins-{type}s-{plugin}-endpoint"] +===== `endpoint` + * Value type is <<string,string>> + * There is no default value for this setting. + +The endpoint to connect to. By default it is constructed using the value of `region`. +This is useful when connecting to S3 compatible services, but beware that these aren't +guaranteed to work correctly with the AWS SDK. + [id="plugins-{type}s-{plugin}-id_field"] ===== `id_field` * Value type is <<string,string>> * There is no default value for this setting. @@ -175,15 +188,33 @@ Name of the SQS Queue name to pull messages from. Note that this is just the name of the queue, not the URL or ARN. [id="plugins-{type}s-{plugin}-region"] ===== `region` - * Value can be any of: `us-east-1`, `us-east-2`, `us-west-1`, `us-west-2`, `eu-central-1`, `eu-west-1`, `eu-west-2`, `ap-southeast-1`, `ap-southeast-2`, `ap-northeast-1`, `ap-northeast-2`, `sa-east-1`, `us-gov-west-1`, `cn-north-1`, `ap-south-1`, `ca-central-1` + * Value type is <<string,string>> * Default value is `"us-east-1"` The AWS Region +[id="plugins-{type}s-{plugin}-role_arn"] +===== `role_arn` + + * Value type is <<string,string>> + * There is no default value for this setting. + +The AWS IAM Role to assume, if any. +This is used to generate temporary credentials, typically for cross-account access. +See the https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html[AssumeRole API documentation] for more information. + +[id="plugins-{type}s-{plugin}-role_session_name"] +===== `role_session_name` + + * Value type is <<string,string>> + * Default value is `"logstash"` + +Session name to use when assuming an IAM role. + [id="plugins-{type}s-{plugin}-secret_access_key"] ===== `secret_access_key` * Value type is <<string,string>> * There is no default value for this setting. @@ -215,6 +246,6 @@ [id="plugins-{type}s-{plugin}-common-options"] -include::{include_path}/{type}.asciidoc[] \ No newline at end of file +include::{include_path}/{type}.asciidoc[]