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

Interface SplunkDestinationUpdate.Builder

All Superinterfaces:

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

Enclosing class:

SplunkDestinationUpdate

@Mutable
@NotThreadSafe
public static interface SplunkDestinationUpdate.Builder
extends SdkPojo, CopyableBuilder<SplunkDestinationUpdate.Builder,SplunkDestinationUpdate>

Method Summary

Modifier and Type	Method	Description
default SplunkDestinationUpdate.Builder	bufferingHints(Consumer<SplunkBufferingHints.Builder> bufferingHints)	The buffering options.
SplunkDestinationUpdate.Builder	bufferingHints(SplunkBufferingHints bufferingHints)	The buffering options.
default SplunkDestinationUpdate.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	The Amazon CloudWatch logging options for your Firehose stream.
SplunkDestinationUpdate.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	The Amazon CloudWatch logging options for your Firehose stream.
SplunkDestinationUpdate.Builder	hecAcknowledgmentTimeoutInSeconds(Integer hecAcknowledgmentTimeoutInSeconds)	The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends data.
SplunkDestinationUpdate.Builder	hecEndpoint(String hecEndpoint)	The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
SplunkDestinationUpdate.Builder	hecEndpointType(String hecEndpointType)	This type can be either "Raw" or "Event."
SplunkDestinationUpdate.Builder	hecEndpointType(HECEndpointType hecEndpointType)	This type can be either "Raw" or "Event."
SplunkDestinationUpdate.Builder	hecToken(String hecToken)	A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
default SplunkDestinationUpdate.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	The data processing configuration.
SplunkDestinationUpdate.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	The data processing configuration.
default SplunkDestinationUpdate.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.
SplunkDestinationUpdate.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.
SplunkDestinationUpdate.Builder	s3BackupMode(String s3BackupMode)	Specifies how you want Firehose to back up documents to Amazon S3.
SplunkDestinationUpdate.Builder	s3BackupMode(SplunkS3BackupMode s3BackupMode)	Specifies how you want Firehose to back up documents to Amazon S3.
default SplunkDestinationUpdate.Builder	s3Update(Consumer<S3DestinationUpdate.Builder> s3Update)	Your update to the configuration of the backup Amazon S3 location.
SplunkDestinationUpdate.Builder	s3Update(S3DestinationUpdate s3Update)	Your update to the configuration of the backup Amazon S3 location.
default SplunkDestinationUpdate.Builder	secretsManagerConfiguration(Consumer<SecretsManagerConfiguration.Builder> secretsManagerConfiguration)	The configuration that defines how you access secrets for Splunk.
SplunkDestinationUpdate.Builder	secretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration)	The configuration that defines how you access secrets for Splunk.

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, sdkFieldNameToField, sdkFields

Method Details

hecEndpoint

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

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

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

SplunkDestinationUpdate.Builder hecToken(String hecToken)

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

Parameters:

hecToken - 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

SplunkDestinationUpdate.Builder hecAcknowledgmentTimeoutInSeconds(Integer hecAcknowledgmentTimeoutInSeconds)

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

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

SplunkDestinationUpdate.Builder s3BackupMode(String s3BackupMode)

Specifies how you want Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly, 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 - Specifies how you want Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly, 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

SplunkDestinationUpdate.Builder s3BackupMode(SplunkS3BackupMode s3BackupMode)

Specifies how you want Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly, 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 - Specifies how you want Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly, 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

s3Update

SplunkDestinationUpdate.Builder s3Update(S3DestinationUpdate s3Update)

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

Parameters:

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

Returns:

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

s3Update

default SplunkDestinationUpdate.Builder s3Update(Consumer<S3DestinationUpdate.Builder> s3Update)

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

This is a convenience method that creates an instance of the S3DestinationUpdate.Builder avoiding the need to create one manually via S3DestinationUpdate.builder().

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

Parameters:

s3Update - a consumer that will call methods on S3DestinationUpdate.Builder

Returns:

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

See Also:

• s3Update(S3DestinationUpdate)

processingConfiguration

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

SplunkDestinationUpdate.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

The Amazon CloudWatch logging options for your Firehose stream.

Parameters:

cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your Firehose stream.

Returns:

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

cloudWatchLoggingOptions

default SplunkDestinationUpdate.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)

The Amazon CloudWatch logging options for your Firehose 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

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

secretsManagerConfiguration

SplunkDestinationUpdate.Builder secretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration)

The configuration that defines how you access secrets for Splunk.

Parameters:

secretsManagerConfiguration - The configuration that defines how you access secrets for Splunk.

Returns:

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

secretsManagerConfiguration

default SplunkDestinationUpdate.Builder secretsManagerConfiguration(Consumer<SecretsManagerConfiguration.Builder> secretsManagerConfiguration)

The configuration that defines how you access secrets for Splunk.

This is a convenience method that creates an instance of the SecretsManagerConfiguration.Builder avoiding the need to create one manually via SecretsManagerConfiguration.builder().

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

Parameters:

secretsManagerConfiguration - a consumer that will call methods on SecretsManagerConfiguration.Builder

Returns:

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

See Also:

• secretsManagerConfiguration(SecretsManagerConfiguration)