Package software.amazon.awssdk.services.firehose.model

Interface SplunkDestinationConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SplunkDestinationConfiguration.Builder,SplunkDestinationConfiguration>, SdkBuilder<SplunkDestinationConfiguration.Builder,SplunkDestinationConfiguration>, SdkPojo

Enclosing class:

SplunkDestinationConfiguration

public static interface SplunkDestinationConfiguration.Builder
extends SdkPojo, CopyableBuilder<SplunkDestinationConfiguration.Builder,SplunkDestinationConfiguration>

Method Summary

Modifier and Type	Method	Description
default SplunkDestinationConfiguration.Builder	bufferingHints(Consumer<SplunkBufferingHints.Builder> bufferingHints)	The buffering options.
SplunkDestinationConfiguration.Builder	bufferingHints(SplunkBufferingHints bufferingHints)	The buffering options.
default SplunkDestinationConfiguration.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	The Amazon CloudWatch logging options for your delivery stream.
SplunkDestinationConfiguration.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	The Amazon CloudWatch logging options for your delivery stream.
SplunkDestinationConfiguration.Builder	hecAcknowledgmentTimeoutInSeconds(Integer hecAcknowledgmentTimeoutInSeconds)	The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data.
SplunkDestinationConfiguration.Builder	hecEndpoint(String hecEndpoint)	The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
SplunkDestinationConfiguration.Builder	hecEndpointType(String hecEndpointType)	This type can be either "Raw" or "Event."
SplunkDestinationConfiguration.Builder	hecEndpointType(HECEndpointType hecEndpointType)	This type can be either "Raw" or "Event."
SplunkDestinationConfiguration.Builder	hecToken(String hecToken)	This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
default SplunkDestinationConfiguration.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	The data processing configuration.
SplunkDestinationConfiguration.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	The data processing configuration.
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.
SplunkDestinationConfiguration.Builder	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.
SplunkDestinationConfiguration.Builder	s3BackupMode(String s3BackupMode)	Defines how documents should be delivered to Amazon S3.
SplunkDestinationConfiguration.Builder	s3BackupMode(SplunkS3BackupMode s3BackupMode)	Defines how documents should be delivered to Amazon S3.
default SplunkDestinationConfiguration.Builder	s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration)	The configuration for the backup Amazon S3 location.
SplunkDestinationConfiguration.Builder	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

SplunkDestinationConfiguration.Builder hecEndpoint(String 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

SplunkDestinationConfiguration.Builder hecEndpointType(String 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
• HECEndpointType

hecEndpointType

SplunkDestinationConfiguration.Builder hecEndpointType(HECEndpointType 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
• HECEndpointType

hecToken

SplunkDestinationConfiguration.Builder hecToken(String 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

SplunkDestinationConfiguration.Builder 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.

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 the SplunkRetryOptions.Builder avoiding the need to create one manually via SplunkRetryOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryOptions(SplunkRetryOptions).

Parameters:

retryOptions - a consumer that will call methods on SplunkRetryOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• retryOptions(SplunkRetryOptions)

s3BackupMode

SplunkDestinationConfiguration.Builder s3BackupMode(String 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 to AllEvents, 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.

Parameters:

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 to AllEvents, 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SplunkS3BackupMode
• SplunkS3BackupMode

s3BackupMode

SplunkDestinationConfiguration.Builder s3BackupMode(SplunkS3BackupMode 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 to AllEvents, 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.

Parameters:

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 to AllEvents, 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SplunkS3BackupMode
• SplunkS3BackupMode

s3Configuration

SplunkDestinationConfiguration.Builder s3Configuration(S3DestinationConfiguration 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 the S3DestinationConfiguration.Builder avoiding the need to create one manually via S3DestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3Configuration(S3DestinationConfiguration).

Parameters:

s3Configuration - a consumer that will call methods on S3DestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• s3Configuration(S3DestinationConfiguration)

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 the ProcessingConfiguration.Builder avoiding the need to create one manually via ProcessingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to processingConfiguration(ProcessingConfiguration).

Parameters:

processingConfiguration - a consumer that will call methods on ProcessingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• processingConfiguration(ProcessingConfiguration)

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 the CloudWatchLoggingOptions.Builder avoiding the need to create one manually via CloudWatchLoggingOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchLoggingOptions(CloudWatchLoggingOptions).

Parameters:

cloudWatchLoggingOptions - a consumer that will call methods on CloudWatchLoggingOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• cloudWatchLoggingOptions(CloudWatchLoggingOptions)

bufferingHints

SplunkDestinationConfiguration.Builder bufferingHints(SplunkBufferingHints 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 the SplunkBufferingHints.Builder avoiding the need to create one manually via SplunkBufferingHints.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bufferingHints(SplunkBufferingHints).

Parameters:

bufferingHints - a consumer that will call methods on SplunkBufferingHints.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• bufferingHints(SplunkBufferingHints)