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.SplunkDestinationUpdate

Description

Synopsis

Documentation

data SplunkDestinationUpdate Source #

Describes an update for a destination in Splunk.

See: newSplunkDestinationUpdate smart constructor.

Constructors

SplunkDestinationUpdate'

Fields

s3BackupMode :: Maybe SplunkS3BackupMode
Specifies how you want Kinesis Data Firehose to back up documents 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 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.
hECToken :: Maybe Text
A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
hECEndpointType :: Maybe HECEndpointType
This type can be either "Raw" or "Event."
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 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.
s3Update :: Maybe S3DestinationUpdate
Your update to the configuration of the backup Amazon S3 location.
hECEndpoint :: Maybe Text
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
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.

Instances

Instances details

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

newSplunkDestinationUpdate :: SplunkDestinationUpdate Source #

Create a value of SplunkDestinationUpdate 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:SplunkDestinationUpdate', splunkDestinationUpdate_s3BackupMode - Specifies how you want Kinesis Data Firehose to back up documents 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 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:hECToken:SplunkDestinationUpdate', splunkDestinationUpdate_hECToken - A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

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

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

$sel:hECAcknowledgmentTimeoutInSeconds:SplunkDestinationUpdate', splunkDestinationUpdate_hECAcknowledgmentTimeoutInSeconds - The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends 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:s3Update:SplunkDestinationUpdate', splunkDestinationUpdate_s3Update - Your update to the configuration of the backup Amazon S3 location.

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

$sel:retryOptions:SplunkDestinationUpdate', splunkDestinationUpdate_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:SplunkDestinationUpdate', splunkDestinationUpdate_processingConfiguration - The data processing configuration.

splunkDestinationUpdate_s3BackupMode :: Lens' SplunkDestinationUpdate (Maybe SplunkS3BackupMode) Source #

Specifies how you want Kinesis Data Firehose to back up documents 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 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.

splunkDestinationUpdate_hECToken :: Lens' SplunkDestinationUpdate (Maybe Text) Source #

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

splunkDestinationUpdate_hECEndpointType :: Lens' SplunkDestinationUpdate (Maybe HECEndpointType) Source #

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

splunkDestinationUpdate_cloudWatchLoggingOptions :: Lens' SplunkDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #

The Amazon CloudWatch logging options for your delivery stream.

splunkDestinationUpdate_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationUpdate (Maybe Natural) Source #

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends 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.

splunkDestinationUpdate_s3Update :: Lens' SplunkDestinationUpdate (Maybe S3DestinationUpdate) Source #

Your update to the configuration of the backup Amazon S3 location.

splunkDestinationUpdate_hECEndpoint :: Lens' SplunkDestinationUpdate (Maybe Text) Source #

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

splunkDestinationUpdate_retryOptions :: Lens' SplunkDestinationUpdate (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.

splunkDestinationUpdate_processingConfiguration :: Lens' SplunkDestinationUpdate (Maybe ProcessingConfiguration) Source #

The data processing configuration.