SplunkDestinationConfiguration
Describes the configuration of a destination in Splunk.
Contents
CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
Type: CloudWatchLoggingOptions (p. 82) 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: Yes HECEndpointType
This type can be either "Raw" or "Event."
Type: String
Valid Values: Raw | Event Required: Yes
HECToken
This is a GUID that 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: Yes ProcessingConfiguration
The data processing configuration.
See Also
Type: ProcessingConfiguration (p. 144) 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 (p. 175) object Required: No
S3BackupMode
Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.
You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.
Type: String
Valid Values: FailedEventsOnly | AllEvents Required: No
S3Configuration
The configuration for the backup Amazon S3 location.
Type: S3DestinationConfiguration (p. 159) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SplunkDestinationDescription
SplunkDestinationDescription
Describes a destination in Splunk.
Contents
CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
Type: CloudWatchLoggingOptions (p. 82) 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.
See Also
Type: ProcessingConfiguration (p. 144) 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 (p. 175) 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 to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.
Type: String
Valid Values: FailedEventsOnly | AllEvents Required: No
S3DestinationDescription The Amazon S3 destination.>
Type: S3DestinationDescription (p. 161) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SplunkDestinationUpdate
SplunkDestinationUpdate
Describes an update for a destination in Splunk.
Contents
CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
Type: CloudWatchLoggingOptions (p. 82) object Required: No
HECAcknowledgmentTimeoutInSeconds
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends 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 that 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.
See Also
Type: ProcessingConfiguration (p. 144) 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 (p. 175) object Required: No
S3BackupMode
Specifies how you want Kinesis Data Firehose to back up documents 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 to AllEvents, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.
You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.
Type: String
Valid Values: FailedEventsOnly | AllEvents Required: No
S3Update
Your update to the configuration of the backup Amazon S3 location.
Type: S3DestinationUpdate (p. 163) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SplunkRetryOptions
SplunkRetryOptions
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.
Contents
DurationInSeconds
The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 7200.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Tag
Tag
Metadata that you can assign to a delivery stream, consisting of a key-value pair.
Contents
Key
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$
Required: Yes Value
An optional string, which you can use to describe or define the tag. Maximum length: 256 characters.
Valid characters: Unicode letters, digits, white space, _ . / = + - % @ Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: ^[\p{L}\p{Z}\p{N}_.:\/=+\-@%]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3