You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-firehose/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",
    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.

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The CloudWatch logging options for your delivery stream.



2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2506

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_secondsInteger

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

Returns:

  • (Integer)


2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2506

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_endpointString

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

Returns:

  • (String)


2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2506

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_typeString

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

Returns:

  • (String)


2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2506

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_tokenString

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

Returns:

  • (String)


2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2506

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_configurationTypes::ProcessingConfiguration

The data processing configuration.



2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2506

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_optionsTypes::SplunkRetryOptions

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



2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2506

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_modeString

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

Returns:

  • (String)


2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2506

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_configurationTypes::S3DestinationConfiguration

The configuration for the backup Amazon S3 location.



2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 2506

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