Class: Aws::Firehose::Types::SplunkDestinationUpdate

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

Overview

Describes an update for a destination in Splunk.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hintsTypes::SplunkBufferingHints

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



4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4573

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

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.



4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4573

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

#hec_acknowledgment_timeout_in_secondsInteger

The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends 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)


4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4573

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

#hec_endpointString

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

Returns:

  • (String)


4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4573

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

#hec_endpoint_typeString

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

Returns:

  • (String)


4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4573

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

#hec_tokenString

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

Returns:

  • (String)


4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4573

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

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.



4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4573

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

#retry_optionsTypes::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.



4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4573

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

#s3_backup_modeString

Specifies how you want Firehose to back up documents 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 AllEvents, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly.

You can update this backup mode from FailedEventsOnly to AllEvents. You can't update it from AllEvents to FailedEventsOnly.

Returns:

  • (String)


4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4573

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

#s3_updateTypes::S3DestinationUpdate

Your update to the configuration of the backup Amazon S3 location.



4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4573

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