SplunkDestinationDescription
Describes a destination in Splunk.
Contents
- CloudWatchLoggingOptions
-
The Amazon CloudWatch logging options for your delivery stream.
Type: CloudWatchLoggingOptions object
Required: No
- HECAcknowledgmentTimeoutInSeconds
-
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.
Type: Integer
Valid Range: Minimum value of 180. Maximum value of 600.
Required: No
- HECEndpoint
-
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
.*
Required: No
- HECEndpointType
-
This type can be either "Raw" or "Event."
Type: String
Valid Values:
Raw | Event
Required: No
- HECToken
-
A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
.*
Required: No
- ProcessingConfiguration
-
The data processing configuration.
Type: ProcessingConfiguration object
Required: No
- RetryOptions
-
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
Type: SplunkRetryOptions object
Required: No
- S3BackupMode
-
Defines how documents should be delivered to Amazon S3. When set to
FailedDocumentsOnly
, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllDocuments
, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value isFailedDocumentsOnly
.Type: String
Valid Values:
FailedEventsOnly | AllEvents
Required: No
- S3DestinationDescription
-
The Amazon S3 destination.>
Type: S3DestinationDescription object
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: