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

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

Overview

Describes a destination in Splunk.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.

Returns:



3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/aws-sdk-firehose/types.rb', line 3818

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_seconds ⇒ Integer

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) 


3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/aws-sdk-firehose/types.rb', line 3818

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 ⇒ String

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

Returns:

  • (String) 


3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/aws-sdk-firehose/types.rb', line 3818

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_type ⇒ String

This type can be either “Raw” or “Event.”

Returns:

  • (String) 


3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/aws-sdk-firehose/types.rb', line 3818

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_token ⇒ String

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

Returns:

  • (String) 


3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/aws-sdk-firehose/types.rb', line 3818

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_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:



3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/aws-sdk-firehose/types.rb', line 3818

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_options ⇒ Types::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.

Returns:



3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/aws-sdk-firehose/types.rb', line 3818

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_mode ⇒ String

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) 


3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/aws-sdk-firehose/types.rb', line 3818

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_description ⇒ Types::S3DestinationDescription

The Amazon S3 destination.&gt;

Returns:



3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/aws-sdk-firehose/types.rb', line 3818

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