Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Firehose.Types.SplunkDestinationDescription

Description

Synopsis

Documentation

data SplunkDestinationDescription Source #

Describes a destination in Splunk.

See: newSplunkDestinationDescription smart constructor.

Constructors

SplunkDestinationDescription'

Fields

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.
hECEndpoint :: Maybe Text
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
hECEndpointType :: Maybe HECEndpointType
This type can be either "Raw" or "Event."
hECToken :: Maybe Text
A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
processingConfiguration :: Maybe ProcessingConfiguration
The data processing configuration.
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.
s3BackupMode :: Maybe SplunkS3BackupMode
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.
s3DestinationDescription :: Maybe S3DestinationDescription
The Amazon S3 destination.>

Instances

Instances details

FromJSON SplunkDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationDescription Methods parseJSON :: Value -> Parser SplunkDestinationDescription # parseJSONList :: Value -> Parser [SplunkDestinationDescription] #
Generic SplunkDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationDescription Associated Types type Rep SplunkDestinationDescription :: Type -> Type # Methods from :: SplunkDestinationDescription -> Rep SplunkDestinationDescription x # to :: Rep SplunkDestinationDescription x -> SplunkDestinationDescription #
Read SplunkDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationDescription Methods readsPrec :: Int -> ReadS SplunkDestinationDescription # readList :: ReadS [SplunkDestinationDescription] # readPrec :: ReadPrec SplunkDestinationDescription # readListPrec :: ReadPrec [SplunkDestinationDescription] #
Show SplunkDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationDescription Methods showsPrec :: Int -> SplunkDestinationDescription -> ShowS # show :: SplunkDestinationDescription -> String # showList :: [SplunkDestinationDescription] -> ShowS #
NFData SplunkDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationDescription Methods rnf :: SplunkDestinationDescription -> () #
Eq SplunkDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationDescription Methods (==) :: SplunkDestinationDescription -> SplunkDestinationDescription -> Bool # (/=) :: SplunkDestinationDescription -> SplunkDestinationDescription -> Bool #
Hashable SplunkDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationDescription Methods hashWithSalt :: Int -> SplunkDestinationDescription -> Int # hash :: SplunkDestinationDescription -> Int #
type Rep SplunkDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.SplunkDestinationDescription type Rep SplunkDestinationDescription = D1 ('MetaData "SplunkDestinationDescription" "Amazonka.Firehose.Types.SplunkDestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "SplunkDestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :: S1 ('MetaSel ('Just "hECAcknowledgmentTimeoutInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "hECEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "hECEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HECEndpointType)))) :: ((S1 ('MetaSel ('Just "hECToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))) :: (S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkRetryOptions)) :: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkS3BackupMode)) :: S1 ('MetaSel ('Just "s3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription)))))))

newSplunkDestinationDescription :: SplunkDestinationDescription Source #

Create a value of SplunkDestinationDescription 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:

SplunkDestinationDescription, splunkDestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:hECAcknowledgmentTimeoutInSeconds:SplunkDestinationDescription', splunkDestinationDescription_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:hECEndpoint:SplunkDestinationDescription', splunkDestinationDescription_hECEndpoint - The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

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

$sel:hECToken:SplunkDestinationDescription', splunkDestinationDescription_hECToken - A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.

$sel:processingConfiguration:SplunkDestinationDescription', splunkDestinationDescription_processingConfiguration - The data processing configuration.

$sel:retryOptions:SplunkDestinationDescription', splunkDestinationDescription_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:s3BackupMode:SplunkDestinationDescription', splunkDestinationDescription_s3BackupMode - 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.

$sel:s3DestinationDescription:SplunkDestinationDescription', splunkDestinationDescription_s3DestinationDescription - The Amazon S3 destination.>

splunkDestinationDescription_cloudWatchLoggingOptions :: Lens' SplunkDestinationDescription (Maybe CloudWatchLoggingOptions) Source #

The Amazon CloudWatch logging options for your delivery stream.

splunkDestinationDescription_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationDescription (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.

splunkDestinationDescription_hECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text) Source #

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

splunkDestinationDescription_hECEndpointType :: Lens' SplunkDestinationDescription (Maybe HECEndpointType) Source #

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

splunkDestinationDescription_hECToken :: Lens' SplunkDestinationDescription (Maybe Text) Source #

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

splunkDestinationDescription_processingConfiguration :: Lens' SplunkDestinationDescription (Maybe ProcessingConfiguration) Source #

The data processing configuration.

splunkDestinationDescription_retryOptions :: Lens' SplunkDestinationDescription (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.

splunkDestinationDescription_s3BackupMode :: Lens' SplunkDestinationDescription (Maybe SplunkS3BackupMode) Source #

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.

splunkDestinationDescription_s3DestinationDescription :: Lens' SplunkDestinationDescription (Maybe S3DestinationDescription) Source #

The Amazon S3 destination.>