Interface SplunkDestinationConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SplunkDestinationConfiguration.Builder,
,SplunkDestinationConfiguration> SdkBuilder<SplunkDestinationConfiguration.Builder,
,SplunkDestinationConfiguration> SdkPojo
- Enclosing class:
SplunkDestinationConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionbufferingHints
(Consumer<SplunkBufferingHints.Builder> bufferingHints) The buffering options.bufferingHints
(SplunkBufferingHints bufferingHints) The buffering options.cloudWatchLoggingOptions
(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) The Amazon CloudWatch logging options for your delivery stream.cloudWatchLoggingOptions
(CloudWatchLoggingOptions cloudWatchLoggingOptions) The Amazon CloudWatch logging options for your delivery stream.hecAcknowledgmentTimeoutInSeconds
(Integer hecAcknowledgmentTimeoutInSeconds) The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data.hecEndpoint
(String hecEndpoint) The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.hecEndpointType
(String hecEndpointType) This type can be either "Raw" or "Event."hecEndpointType
(HECEndpointType hecEndpointType) This type can be either "Raw" or "Event."This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.processingConfiguration
(Consumer<ProcessingConfiguration.Builder> processingConfiguration) The data processing configuration.processingConfiguration
(ProcessingConfiguration processingConfiguration) The data processing configuration.retryOptions
(Consumer<SplunkRetryOptions.Builder> retryOptions) The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.retryOptions
(SplunkRetryOptions retryOptions) The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.s3BackupMode
(String s3BackupMode) Defines how documents should be delivered to Amazon S3.s3BackupMode
(SplunkS3BackupMode s3BackupMode) Defines how documents should be delivered to Amazon S3.s3Configuration
(Consumer<S3DestinationConfiguration.Builder> s3Configuration) The configuration for the backup Amazon S3 location.s3Configuration
(S3DestinationConfiguration s3Configuration) The configuration for the backup Amazon S3 location.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
hecEndpoint
The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
- Parameters:
hecEndpoint
- The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hecEndpointType
This type can be either "Raw" or "Event."
- Parameters:
hecEndpointType
- This type can be either "Raw" or "Event."- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hecEndpointType
This type can be either "Raw" or "Event."
- Parameters:
hecEndpointType
- This type can be either "Raw" or "Event."- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hecToken
This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
- Parameters:
hecToken
- This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hecAcknowledgmentTimeoutInSeconds
SplunkDestinationConfiguration.Builder hecAcknowledgmentTimeoutInSeconds(Integer hecAcknowledgmentTimeoutInSeconds) The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
- Parameters:
hecAcknowledgmentTimeoutInSeconds
- The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retryOptions
The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
- Parameters:
retryOptions
- The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retryOptions
default SplunkDestinationConfiguration.Builder retryOptions(Consumer<SplunkRetryOptions.Builder> retryOptions) The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
This is a convenience method that creates an instance of theSplunkRetryOptions.Builder
avoiding the need to create one manually viaSplunkRetryOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretryOptions(SplunkRetryOptions)
.- Parameters:
retryOptions
- a consumer that will call methods onSplunkRetryOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3BackupMode
Defines how documents should be delivered to Amazon S3. When set to
FailedEventsOnly
, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllEvents
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value isFailedEventsOnly
.You can update this backup mode from
FailedEventsOnly
toAllEvents
. You can't update it fromAllEvents
toFailedEventsOnly
.- Parameters:
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When set toFailedEventsOnly
, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllEvents
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value isFailedEventsOnly
.You can update this backup mode from
FailedEventsOnly
toAllEvents
. You can't update it fromAllEvents
toFailedEventsOnly
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3BackupMode
Defines how documents should be delivered to Amazon S3. When set to
FailedEventsOnly
, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllEvents
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value isFailedEventsOnly
.You can update this backup mode from
FailedEventsOnly
toAllEvents
. You can't update it fromAllEvents
toFailedEventsOnly
.- Parameters:
s3BackupMode
- Defines how documents should be delivered to Amazon S3. When set toFailedEventsOnly
, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllEvents
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value isFailedEventsOnly
.You can update this backup mode from
FailedEventsOnly
toAllEvents
. You can't update it fromAllEvents
toFailedEventsOnly
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3Configuration
The configuration for the backup Amazon S3 location.
- Parameters:
s3Configuration
- The configuration for the backup Amazon S3 location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Configuration
default SplunkDestinationConfiguration.Builder s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration) The configuration for the backup Amazon S3 location.
This is a convenience method that creates an instance of theS3DestinationConfiguration.Builder
avoiding the need to create one manually viaS3DestinationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3Configuration(S3DestinationConfiguration)
.- Parameters:
s3Configuration
- a consumer that will call methods onS3DestinationConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
processingConfiguration
SplunkDestinationConfiguration.Builder processingConfiguration(ProcessingConfiguration processingConfiguration) The data processing configuration.
- Parameters:
processingConfiguration
- The data processing configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
processingConfiguration
default SplunkDestinationConfiguration.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration) The data processing configuration.
This is a convenience method that creates an instance of theProcessingConfiguration.Builder
avoiding the need to create one manually viaProcessingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprocessingConfiguration(ProcessingConfiguration)
.- Parameters:
processingConfiguration
- a consumer that will call methods onProcessingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cloudWatchLoggingOptions
SplunkDestinationConfiguration.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) The Amazon CloudWatch logging options for your delivery stream.
- Parameters:
cloudWatchLoggingOptions
- The Amazon CloudWatch logging options for your delivery stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cloudWatchLoggingOptions
default SplunkDestinationConfiguration.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) The Amazon CloudWatch logging options for your delivery stream.
This is a convenience method that creates an instance of theCloudWatchLoggingOptions.Builder
avoiding the need to create one manually viaCloudWatchLoggingOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocloudWatchLoggingOptions(CloudWatchLoggingOptions)
.- Parameters:
cloudWatchLoggingOptions
- a consumer that will call methods onCloudWatchLoggingOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
bufferingHints
The buffering options. If no value is specified, the default values for Splunk are used.
- Parameters:
bufferingHints
- The buffering options. If no value is specified, the default values for Splunk are used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bufferingHints
default SplunkDestinationConfiguration.Builder bufferingHints(Consumer<SplunkBufferingHints.Builder> bufferingHints) The buffering options. If no value is specified, the default values for Splunk are used.
This is a convenience method that creates an instance of theSplunkBufferingHints.Builder
avoiding the need to create one manually viaSplunkBufferingHints.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobufferingHints(SplunkBufferingHints)
.- Parameters:
bufferingHints
- a consumer that will call methods onSplunkBufferingHints.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-