Class: Aws::Firehose::Types::SplunkDestinationDescription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb

Overview

Describes a destination in Splunk.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.



4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4721

class SplunkDestinationDescription < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#hec_acknowledgment_timeout_in_secondsInteger

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.

Returns:

  • (Integer)


4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4721

class SplunkDestinationDescription < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#hec_endpointString

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

Returns:

  • (String)


4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4721

class SplunkDestinationDescription < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#hec_endpoint_typeString

This type can be either "Raw" or "Event."

Returns:

  • (String)


4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4721

class SplunkDestinationDescription < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#hec_tokenString

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

Returns:

  • (String)


4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4721

class SplunkDestinationDescription < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4721

class SplunkDestinationDescription < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#retry_optionsTypes::SplunkRetryOptions

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.



4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4721

class SplunkDestinationDescription < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#s3_backup_modeString

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.

Returns:

  • (String)


4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4721

class SplunkDestinationDescription < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end

#s3_destination_descriptionTypes::S3DestinationDescription

The Amazon S3 destination.>



4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4721

class SplunkDestinationDescription < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_destination_description,
  :processing_configuration,
  :cloud_watch_logging_options)
  SENSITIVE = []
  include Aws::Structure
end