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

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

Overview

Note:

When making an API call, you may pass SplunkDestinationConfiguration data as a hash:

{
  hec_endpoint: "HECEndpoint", # required
  hec_endpoint_type: "Raw", # required, accepts Raw, Event
  hec_token: "HECToken", # required
  hec_acknowledgment_timeout_in_seconds: 1,
  retry_options: {
    duration_in_seconds: 1,
  },
  s3_backup_mode: "FailedEventsOnly", # accepts FailedEventsOnly, AllEvents
  s3_configuration: { # required
    role_arn: "RoleARN", # required
    bucket_arn: "BucketARN", # required
    prefix: "Prefix",
    error_output_prefix: "ErrorOutputPrefix",
    buffering_hints: {
      size_in_m_bs: 1,
      interval_in_seconds: 1,
    },
    compression_format: "UNCOMPRESSED", # accepts UNCOMPRESSED, GZIP, ZIP, Snappy
    encryption_configuration: {
      no_encryption_config: "NoEncryption", # accepts NoEncryption
      kms_encryption_config: {
        awskms_key_arn: "AWSKMSKeyARN", # required
      },
    },
    cloud_watch_logging_options: {
      enabled: false,
      log_group_name: "LogGroupName",
      log_stream_name: "LogStreamName",
    },
  },
  processing_configuration: {
    enabled: false,
    processors: [
      {
        type: "Lambda", # required, accepts Lambda
        parameters: [
          {
            parameter_name: "LambdaArn", # required, accepts LambdaArn, NumberOfRetries, RoleArn, BufferSizeInMBs, BufferIntervalInSeconds
            parameter_value: "ProcessorParameterValue", # required
          },
        ],
      },
    ],
  },
  cloud_watch_logging_options: {
    enabled: false,
    log_group_name: "LogGroupName",
    log_stream_name: "LogStreamName",
  },
}

Describes the configuration of 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:



3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
 
# File 'lib/aws-sdk-firehose/types.rb', line 3619

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


3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
 
# File 'lib/aws-sdk-firehose/types.rb', line 3619

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

#hec_endpoint ⇒ String

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

Returns:

  • (String) 


3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
 
# File 'lib/aws-sdk-firehose/types.rb', line 3619

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

#hec_endpoint_type ⇒ String

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

Returns:

  • (String) 


3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
 
# File 'lib/aws-sdk-firehose/types.rb', line 3619

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


3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
 
# File 'lib/aws-sdk-firehose/types.rb', line 3619

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

#processing_configuration ⇒ Types::ProcessingConfiguration

The data processing configuration.

Returns:



3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
 
# File 'lib/aws-sdk-firehose/types.rb', line 3619

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



3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
 
# File 'lib/aws-sdk-firehose/types.rb', line 3619

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


3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
 
# File 'lib/aws-sdk-firehose/types.rb', line 3619

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

#s3_configuration ⇒ Types::S3DestinationConfiguration

The configuration for the backup Amazon S3 location.

Returns:



3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
 
# File 'lib/aws-sdk-firehose/types.rb', line 3619

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