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

Inherits:

Struct

• Object
• Struct
• Aws::Firehose::Types::SplunkDestinationDescription

Includes:

Structure

Defined in:

lib/aws-sdk-firehose/types.rb

Overview

Describes a destination in Splunk.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #buffering_hints ⇒ Types::SplunkBufferingHints

  The buffering options.

• #cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

  The Amazon CloudWatch logging options for your delivery stream.

• #hec_acknowledgment_timeout_in_seconds ⇒ Integer

  The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data.

• #hec_endpoint ⇒ String

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

• #hec_endpoint_type ⇒ String

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

• #hec_token ⇒ String

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

• #processing_configuration ⇒ Types::ProcessingConfiguration

  The data processing configuration.

• #retry_options ⇒ Types::SplunkRetryOptions

  The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn’t receive an acknowledgment of receipt from Splunk.

• #s3_backup_mode ⇒ String

  Defines how documents should be delivered to Amazon S3.

• #s3_destination_description ⇒ Types::S3DestinationDescription

  The Amazon S3 destination.>.

Instance Attribute Details

#buffering_hints ⇒ Types::SplunkBufferingHints

The buffering options. If no value is specified, the default values for Splunk are used.

Returns:

• (Types::SplunkBufferingHints)

# File 'lib/aws-sdk-firehose/types.rb', line 4480

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,
  :buffering_hints)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.

Returns:

• (Types::CloudWatchLoggingOptions)

# File 'lib/aws-sdk-firehose/types.rb', line 4480

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,
  :buffering_hints)
  SENSITIVE = []
  include Aws::Structure
end

#hec_acknowledgment_timeout_in_seconds ⇒ Integer

The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.

Returns:

• (Integer)

# File 'lib/aws-sdk-firehose/types.rb', line 4480

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,
  :buffering_hints)
  SENSITIVE = []
  include Aws::Structure
end

#hec_endpoint ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4480

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,
  :buffering_hints)
  SENSITIVE = []
  include Aws::Structure
end

#hec_endpoint_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4480

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,
  :buffering_hints)
  SENSITIVE = []
  include Aws::Structure
end

#hec_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4480

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,
  :buffering_hints)
  SENSITIVE = []
  include Aws::Structure
end

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:

• (Types::ProcessingConfiguration)

# File 'lib/aws-sdk-firehose/types.rb', line 4480

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,
  :buffering_hints)
  SENSITIVE = []
  include Aws::Structure
end

#retry_options ⇒ Types::SplunkRetryOptions

The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn’t receive an acknowledgment of receipt from Splunk.

Returns:

• (Types::SplunkRetryOptions)

# File 'lib/aws-sdk-firehose/types.rb', line 4480

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,
  :buffering_hints)
  SENSITIVE = []
  include Aws::Structure
end

#s3_backup_mode ⇒ String

Defines how documents should be delivered to Amazon S3. When set to ‘FailedDocumentsOnly`, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to `AllDocuments`, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is `FailedDocumentsOnly`.

Returns:

• (String)

# File 'lib/aws-sdk-firehose/types.rb', line 4480

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,
  :buffering_hints)
  SENSITIVE = []
  include Aws::Structure
end

#s3_destination_description ⇒ Types::S3DestinationDescription

The Amazon S3 destination.>

Returns:

• (Types::S3DestinationDescription)

# File 'lib/aws-sdk-firehose/types.rb', line 4480

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,
  :buffering_hints)
  SENSITIVE = []
  include Aws::Structure
end