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
- data SplunkDestinationUpdate = SplunkDestinationUpdate' {
- s3BackupMode :: Maybe SplunkS3BackupMode
- hECToken :: Maybe Text
- hECEndpointType :: Maybe HECEndpointType
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- hECAcknowledgmentTimeoutInSeconds :: Maybe Natural
- s3Update :: Maybe S3DestinationUpdate
- hECEndpoint :: Maybe Text
- retryOptions :: Maybe SplunkRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- newSplunkDestinationUpdate :: SplunkDestinationUpdate
- splunkDestinationUpdate_s3BackupMode :: Lens' SplunkDestinationUpdate (Maybe SplunkS3BackupMode)
- splunkDestinationUpdate_hECToken :: Lens' SplunkDestinationUpdate (Maybe Text)
- splunkDestinationUpdate_hECEndpointType :: Lens' SplunkDestinationUpdate (Maybe HECEndpointType)
- splunkDestinationUpdate_cloudWatchLoggingOptions :: Lens' SplunkDestinationUpdate (Maybe CloudWatchLoggingOptions)
- splunkDestinationUpdate_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationUpdate (Maybe Natural)
- splunkDestinationUpdate_s3Update :: Lens' SplunkDestinationUpdate (Maybe S3DestinationUpdate)
- splunkDestinationUpdate_hECEndpoint :: Lens' SplunkDestinationUpdate (Maybe Text)
- splunkDestinationUpdate_retryOptions :: Lens' SplunkDestinationUpdate (Maybe SplunkRetryOptions)
- splunkDestinationUpdate_processingConfiguration :: Lens' SplunkDestinationUpdate (Maybe ProcessingConfiguration)
Documentation
data SplunkDestinationUpdate Source #
Describes an update for a destination in Splunk.
See: newSplunkDestinationUpdate
smart constructor.
Constructors
SplunkDestinationUpdate' | |
Fields
|
Instances
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.