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.SplunkDestinationDescription
Description
Synopsis
- data SplunkDestinationDescription = SplunkDestinationDescription' {
- s3BackupMode :: Maybe SplunkS3BackupMode
- hECToken :: Maybe Text
- hECEndpointType :: Maybe HECEndpointType
- cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
- hECAcknowledgmentTimeoutInSeconds :: Maybe Natural
- s3DestinationDescription :: Maybe S3DestinationDescription
- hECEndpoint :: Maybe Text
- retryOptions :: Maybe SplunkRetryOptions
- processingConfiguration :: Maybe ProcessingConfiguration
- newSplunkDestinationDescription :: SplunkDestinationDescription
- splunkDestinationDescription_s3BackupMode :: Lens' SplunkDestinationDescription (Maybe SplunkS3BackupMode)
- splunkDestinationDescription_hECToken :: Lens' SplunkDestinationDescription (Maybe Text)
- splunkDestinationDescription_hECEndpointType :: Lens' SplunkDestinationDescription (Maybe HECEndpointType)
- splunkDestinationDescription_cloudWatchLoggingOptions :: Lens' SplunkDestinationDescription (Maybe CloudWatchLoggingOptions)
- splunkDestinationDescription_hECAcknowledgmentTimeoutInSeconds :: Lens' SplunkDestinationDescription (Maybe Natural)
- splunkDestinationDescription_s3DestinationDescription :: Lens' SplunkDestinationDescription (Maybe S3DestinationDescription)
- splunkDestinationDescription_hECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text)
- splunkDestinationDescription_retryOptions :: Lens' SplunkDestinationDescription (Maybe SplunkRetryOptions)
- splunkDestinationDescription_processingConfiguration :: Lens' SplunkDestinationDescription (Maybe ProcessingConfiguration)
Documentation
data SplunkDestinationDescription Source #
Describes a destination in Splunk.
See: newSplunkDestinationDescription
smart constructor.
Constructors
SplunkDestinationDescription' | |
Fields
|
Instances
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:
$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:hECToken:SplunkDestinationDescription'
, splunkDestinationDescription_hECToken
- A GUID you obtain from your Splunk cluster when you create a new HEC
endpoint.
$sel:hECEndpointType:SplunkDestinationDescription'
, splunkDestinationDescription_hECEndpointType
- This type can be either "Raw" or "Event."
$sel:cloudWatchLoggingOptions: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:s3DestinationDescription:SplunkDestinationDescription'
, splunkDestinationDescription_s3DestinationDescription
- The Amazon S3 destination.>
$sel:hECEndpoint:SplunkDestinationDescription'
, splunkDestinationDescription_hECEndpoint
- The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose
sends your data.
$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:processingConfiguration:SplunkDestinationDescription'
, splunkDestinationDescription_processingConfiguration
- The data processing configuration.
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_hECToken :: Lens' SplunkDestinationDescription (Maybe Text) Source #
A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
splunkDestinationDescription_hECEndpointType :: Lens' SplunkDestinationDescription (Maybe HECEndpointType) Source #
This type can be either "Raw" or "Event."
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_s3DestinationDescription :: Lens' SplunkDestinationDescription (Maybe S3DestinationDescription) Source #
The Amazon S3 destination.>
splunkDestinationDescription_hECEndpoint :: Lens' SplunkDestinationDescription (Maybe Text) Source #
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
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_processingConfiguration :: Lens' SplunkDestinationDescription (Maybe ProcessingConfiguration) Source #
The data processing configuration.