Class: Aws::Firehose::Types::SplunkDestinationConfiguration

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

Overview

Describes the configuration of a destination in Splunk.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#buffering_hints ⇒ Types::SplunkBufferingHints

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

Returns:



5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

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

#cloud_watch_logging_options ⇒ Types::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your Firehose stream.

Returns:



5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

class SplunkDestinationConfiguration < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options,
  :buffering_hints,
  :secrets_manager_configuration)
  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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

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

#hec_endpoint ⇒ String

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

Returns:

  • (String) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

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

#hec_endpoint_type ⇒ String

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

Returns:

  • (String) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

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

#hec_token ⇒ String

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

Returns:

  • (String) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

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

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:



5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

class SplunkDestinationConfiguration < Struct.new(
  :hec_endpoint,
  :hec_endpoint_type,
  :hec_token,
  :hec_acknowledgment_timeout_in_seconds,
  :retry_options,
  :s3_backup_mode,
  :s3_configuration,
  :processing_configuration,
  :cloud_watch_logging_options,
  :buffering_hints,
  :secrets_manager_configuration)
  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:



5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

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

#s3_backup_mode ⇒ String

Defines how documents should be delivered to Amazon S3. When set to ‘FailedEventsOnly`, 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) 


5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

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

#s3_configuration ⇒ Types::S3DestinationConfiguration

The configuration for the backup Amazon S3 location.

Returns:



5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

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

#secrets_manager_configuration ⇒ Types::SecretsManagerConfiguration

The configuration that defines how you access secrets for Splunk.

Returns:



5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
 
# File 'lib/aws-sdk-firehose/types.rb', line 5496

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