Amazon Kinesis Data Firehose DeliveryStream SplunkDestinationConfiguration

The SplunkDestinationConfiguration property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.

SplunkDestinationConfiguration is a property of the AWS::KinesisFirehose::DeliveryStream resource.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "CloudWatchLoggingOptions" : CloudWatchLoggingOptions,
  "HECAcknowledgmentTimeoutInSeconds" : Integer,
  "HECEndpoint" : String,
  "HECEndpointType" : String,
  "HECToken" : String,
  "ProcessingConfiguration" : ProcessingConfiguration,
  "RetryOptions" : RetryOptions,
  "S3BackupMode" : String,
  "S3Configuration" : S3Configuration
}

YAML


CloudWatchLoggingOptions:
  CloudWatchLoggingOptions
HECAcknowledgmentTimeoutInSeconds: Integer
HECEndpoint: String
HECEndpointType: String
HECToken: String
ProcessingConfiguration:
  ProcessingConfiguration
RetryOptions:
  RetryOptions
S3BackupMode: String
S3Configuration:
  S3Configuration

Properties

CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.

Required: No

Type: CloudWatchLoggingOptions

Update requires: No interruption

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.

Valid Range: Minimum value of 180. Maximum value of 600.

Required: No

Type: Integer

Update requires: No interruption

HECEndpoint

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

Required: Yes

Type: String

Update requires: No interruption

HECEndpointType

This type can be either Raw or Event.

Required: Yes

Type: String

Update requires: No interruption

HECToken

A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

Required: Yes

Type: String

Update requires: No interruption

ProcessingConfiguration

The data processing configuration.

Required: No

Type: ProcessingConfiguration

Update requires: No interruption

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.

Required: No

Type: SplunkRetryOptions

Update requires: No interruption

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. Default value is FailedEventsOnly.

Valid values include FailedEventsOnly and AllEvents.

Required: No

Type: String

Update requires: No interruption

S3Configuration

The configuration for the backup Amazon S3 location.

Required: Yes

Type: S3DestinationConfiguration

Update requires: No interruption

Amazon Kinesis Data Firehose DeliveryStream SplunkDestinationConfiguration

Syntax

JSON

YAML

Properties

See Also