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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SplunkDestinationConfiguration as input to an Aws::Client method, you can use a vanilla 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, HADOOP_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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logging_optionsTypes::CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.

Returns:

#hec_acknowledgment_timeout_in_secondsInteger

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)

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

#hec_endpointString

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

Returns:

  • (String)

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

#hec_endpoint_typeString

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

Possible values:

  • Raw
  • Event

Returns:

  • (String)

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

#hec_tokenString

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

Returns:

  • (String)

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

#processing_configurationTypes::ProcessingConfiguration

The data processing configuration.

Returns:

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

  • (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.

#s3_backup_modeString

Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents, Kinesis Data 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.

Possible values:

  • FailedEventsOnly
  • AllEvents

Returns:

  • (String)

    Defines how documents should be delivered to Amazon S3.

#s3_configurationTypes::S3DestinationConfiguration

The configuration for the backup Amazon S3 location.

Returns: