Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Firehose.Types.SplunkDestinationConfiguration

Description

Synopsis

Documentation

data SplunkDestinationConfiguration Source #

Describes the configuration of a destination in Splunk.

See: newSplunkDestinationConfiguration smart constructor.

Constructors

SplunkDestinationConfiguration'

Fields

s3BackupMode :: Maybe SplunkS3BackupMode
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.
cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
hECAcknowledgmentTimeoutInSeconds :: Maybe Natural
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.
retryOptions :: Maybe 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.
processingConfiguration :: Maybe ProcessingConfiguration
The data processing configuration.
hECEndpoint :: Text
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
hECEndpointType :: HECEndpointType
This type can be either "Raw" or "Event."
hECToken :: Text
This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
s3Configuration :: S3DestinationConfiguration
The configuration for the backup Amazon S3 location.

Instances

Instances details

Eq SplunkDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration Methods (==) :: SplunkDestinationConfiguration -> SplunkDestinationConfiguration -> Bool # (/=) :: SplunkDestinationConfiguration -> SplunkDestinationConfiguration -> Bool #
Read SplunkDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration Methods readsPrec :: Int -> ReadS SplunkDestinationConfiguration # readList :: ReadS [SplunkDestinationConfiguration] # readPrec :: ReadPrec SplunkDestinationConfiguration # readListPrec :: ReadPrec [SplunkDestinationConfiguration] #
Show SplunkDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration Methods showsPrec :: Int -> SplunkDestinationConfiguration -> ShowS # show :: SplunkDestinationConfiguration -> String # showList :: [SplunkDestinationConfiguration] -> ShowS #
Generic SplunkDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration Associated Types type Rep SplunkDestinationConfiguration :: Type -> Type # Methods from :: SplunkDestinationConfiguration -> Rep SplunkDestinationConfiguration x # to :: Rep SplunkDestinationConfiguration x -> SplunkDestinationConfiguration #
NFData SplunkDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration Methods rnf :: SplunkDestinationConfiguration -> () #
Hashable SplunkDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration Methods hashWithSalt :: Int -> SplunkDestinationConfiguration -> Int # hash :: SplunkDestinationConfiguration -> Int #
ToJSON SplunkDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration Methods toJSON :: SplunkDestinationConfiguration -> Value # toEncoding :: SplunkDestinationConfiguration -> Encoding # toJSONList :: [SplunkDestinationConfiguration] -> Value # toEncodingList :: [SplunkDestinationConfiguration] -> Encoding #
type Rep SplunkDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationConfiguration type Rep SplunkDestinationConfiguration = D1 ('MetaData "SplunkDestinationConfiguration" "Amazonka.Firehose.Types.SplunkDestinationConfiguration" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "SplunkDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkS3BackupMode)) :: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :: (S1 ('MetaSel ('Just "hECAcknowledgmentTimeoutInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkRetryOptions)))) :: ((S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :: S1 ('MetaSel ('Just "hECEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "hECEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HECEndpointType) :: (S1 ('MetaSel ('Just "hECToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationConfiguration))))))

newSplunkDestinationConfiguration Source #

Arguments

:: Text	`$sel:hECEndpoint:SplunkDestinationConfiguration'`
-> HECEndpointType	`$sel:hECEndpointType:SplunkDestinationConfiguration'`
-> Text	`$sel:hECToken:SplunkDestinationConfiguration'`
-> S3DestinationConfiguration	`$sel:s3Configuration:SplunkDestinationConfiguration'`
-> SplunkDestinationConfiguration

Create a value of SplunkDestinationConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3BackupMode:SplunkDestinationConfiguration', splunkDestinationConfiguration_s3BackupMode - 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.

$sel:cloudWatchLoggingOptions:SplunkDestinationConfiguration', splunkDestinationConfiguration_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:hECAcknowledgmentTimeoutInSeconds:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECAcknowledgmentTimeoutInSeconds - 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.

$sel:retryOptions:SplunkDestinationConfiguration', splunkDestinationConfiguration_retryOptions - 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.

$sel:processingConfiguration:SplunkDestinationConfiguration', splunkDestinationConfiguration_processingConfiguration - The data processing configuration.

$sel:hECEndpoint:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECEndpoint - The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

$sel:hECEndpointType:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECEndpointType - This type can be either "Raw" or "Event."

$sel:hECToken:SplunkDestinationConfiguration', splunkDestinationConfiguration_hECToken - This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

$sel:s3Configuration:SplunkDestinationConfiguration', splunkDestinationConfiguration_s3Configuration - The configuration for the backup Amazon S3 location.

splunkDestinationConfiguration_s3BackupMode :: Lens' SplunkDestinationConfiguration (Maybe SplunkS3BackupMode) Source #

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.

splunkDestinationConfiguration_cloudWatchLoggingOptions :: Lens' SplunkDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #

The Amazon CloudWatch logging options for your delivery stream.

splunkDestinationConfiguration_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationConfiguration (Maybe Natural) Source #

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.

splunkDestinationConfiguration_retryOptions :: Lens' SplunkDestinationConfiguration (Maybe SplunkRetryOptions) Source #

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.

splunkDestinationConfiguration_processingConfiguration :: Lens' SplunkDestinationConfiguration (Maybe ProcessingConfiguration) Source #

The data processing configuration.

splunkDestinationConfiguration_hECEndpoint :: Lens' SplunkDestinationConfiguration Text Source #

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

splunkDestinationConfiguration_hECEndpointType :: Lens' SplunkDestinationConfiguration HECEndpointType Source #

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

splunkDestinationConfiguration_hECToken :: Lens' SplunkDestinationConfiguration Text Source #

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

splunkDestinationConfiguration_s3Configuration :: Lens' SplunkDestinationConfiguration S3DestinationConfiguration Source #

The configuration for the backup Amazon S3 location.