You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.



3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3560

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)
  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)


3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3560

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)
  include Aws::Structure
end

#hec_endpointString

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

Returns:

  • (String)


3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3560

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)
  include Aws::Structure
end

#hec_endpoint_typeString

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

Returns:

  • (String)


3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3560

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)
  include Aws::Structure
end

#hec_tokenString

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

Returns:

  • (String)


3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3560

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)
  include Aws::Structure
end

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3560

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)
  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.



3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3560

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)
  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)


3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3560

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)
  include Aws::Structure
end

#s3_destination_descriptionTypes::S3DestinationDescription

The Amazon S3 destination.>



3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3560

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)
  include Aws::Structure
end