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

Interface ExtendedS3DestinationConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ExtendedS3DestinationConfiguration

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

Method Summary

Modifier and Type	Method	Description
ExtendedS3DestinationConfiguration.Builder	bucketARN(String bucketARN)	The ARN of the S3 bucket.
default ExtendedS3DestinationConfiguration.Builder	bufferingHints(Consumer<BufferingHints.Builder> bufferingHints)	The buffering option.
ExtendedS3DestinationConfiguration.Builder	bufferingHints(BufferingHints bufferingHints)	The buffering option.
default ExtendedS3DestinationConfiguration.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	The Amazon CloudWatch logging options for your delivery stream.
ExtendedS3DestinationConfiguration.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	The Amazon CloudWatch logging options for your delivery stream.
ExtendedS3DestinationConfiguration.Builder	compressionFormat(String compressionFormat)	The compression format.
ExtendedS3DestinationConfiguration.Builder	compressionFormat(CompressionFormat compressionFormat)	The compression format.
ExtendedS3DestinationConfiguration.Builder	customTimeZone(String customTimeZone)	The time zone you prefer.
default ExtendedS3DestinationConfiguration.Builder	dataFormatConversionConfiguration(Consumer<DataFormatConversionConfiguration.Builder> dataFormatConversionConfiguration)	The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
ExtendedS3DestinationConfiguration.Builder	dataFormatConversionConfiguration(DataFormatConversionConfiguration dataFormatConversionConfiguration)	The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
default ExtendedS3DestinationConfiguration.Builder	dynamicPartitioningConfiguration(Consumer<DynamicPartitioningConfiguration.Builder> dynamicPartitioningConfiguration)	The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys.
ExtendedS3DestinationConfiguration.Builder	dynamicPartitioningConfiguration(DynamicPartitioningConfiguration dynamicPartitioningConfiguration)	The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys.
default ExtendedS3DestinationConfiguration.Builder	encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)	The encryption configuration.
ExtendedS3DestinationConfiguration.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	The encryption configuration.
ExtendedS3DestinationConfiguration.Builder	errorOutputPrefix(String errorOutputPrefix)	A prefix that Firehose evaluates and adds to failed records before writing them to S3.
ExtendedS3DestinationConfiguration.Builder	fileExtension(String fileExtension)	Specify a file extension.
ExtendedS3DestinationConfiguration.Builder	prefix(String prefix)	The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.
default ExtendedS3DestinationConfiguration.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	The data processing configuration.
ExtendedS3DestinationConfiguration.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	The data processing configuration.
ExtendedS3DestinationConfiguration.Builder	roleARN(String roleARN)	The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
default ExtendedS3DestinationConfiguration.Builder	s3BackupConfiguration(Consumer<S3DestinationConfiguration.Builder> s3BackupConfiguration)	The configuration for backup in Amazon S3.
ExtendedS3DestinationConfiguration.Builder	s3BackupConfiguration(S3DestinationConfiguration s3BackupConfiguration)	The configuration for backup in Amazon S3.
ExtendedS3DestinationConfiguration.Builder	s3BackupMode(String s3BackupMode)	The Amazon S3 backup mode.
ExtendedS3DestinationConfiguration.Builder	s3BackupMode(S3BackupMode s3BackupMode)	The Amazon S3 backup mode.

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

roleARN

ExtendedS3DestinationConfiguration.Builder roleARN(String roleARN)

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Parameters:

roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Returns:

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

bucketARN

ExtendedS3DestinationConfiguration.Builder bucketARN(String bucketARN)

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Parameters:

bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Returns:

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

prefix

ExtendedS3DestinationConfiguration.Builder prefix(String prefix)

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

Parameters:

prefix - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

Returns:

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

errorOutputPrefix

ExtendedS3DestinationConfiguration.Builder errorOutputPrefix(String errorOutputPrefix)

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

Parameters:

errorOutputPrefix - A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

Returns:

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

bufferingHints

ExtendedS3DestinationConfiguration.Builder bufferingHints(BufferingHints bufferingHints)

The buffering option.

Parameters:

bufferingHints - The buffering option.

Returns:

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

bufferingHints

default ExtendedS3DestinationConfiguration.Builder bufferingHints(Consumer<BufferingHints.Builder> bufferingHints)

The buffering option.

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

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

Parameters:

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

Returns:

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

See Also:

• bufferingHints(BufferingHints)

compressionFormat

ExtendedS3DestinationConfiguration.Builder compressionFormat(String compressionFormat)

The compression format. If no value is specified, the default is UNCOMPRESSED.

Parameters:

compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.

Returns:

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

See Also:

• CompressionFormat
• CompressionFormat

compressionFormat

ExtendedS3DestinationConfiguration.Builder compressionFormat(CompressionFormat compressionFormat)

The compression format. If no value is specified, the default is UNCOMPRESSED.

Parameters:

compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.

Returns:

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

See Also:

• CompressionFormat
• CompressionFormat

encryptionConfiguration

ExtendedS3DestinationConfiguration.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

The encryption configuration. If no value is specified, the default is no encryption.

Parameters:

encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.

Returns:

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

encryptionConfiguration

default ExtendedS3DestinationConfiguration.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

The encryption configuration. If no value is specified, the default is no encryption.

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

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

Parameters:

encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder

Returns:

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

See Also:

• encryptionConfiguration(EncryptionConfiguration)

cloudWatchLoggingOptions

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

processingConfiguration

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

s3BackupMode

ExtendedS3DestinationConfiguration.Builder s3BackupMode(String s3BackupMode)

The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

Parameters:

s3BackupMode - The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

Returns:

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

See Also:

• S3BackupMode
• S3BackupMode

s3BackupMode

ExtendedS3DestinationConfiguration.Builder s3BackupMode(S3BackupMode s3BackupMode)

The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

Parameters:

s3BackupMode - The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

Returns:

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

See Also:

• S3BackupMode
• S3BackupMode

s3BackupConfiguration

ExtendedS3DestinationConfiguration.Builder s3BackupConfiguration(S3DestinationConfiguration s3BackupConfiguration)

The configuration for backup in Amazon S3.

Parameters:

s3BackupConfiguration - The configuration for backup in Amazon S3.

Returns:

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

s3BackupConfiguration

default ExtendedS3DestinationConfiguration.Builder s3BackupConfiguration(Consumer<S3DestinationConfiguration.Builder> s3BackupConfiguration)

The configuration for backup in Amazon S3.

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 s3BackupConfiguration(S3DestinationConfiguration).

Parameters:

s3BackupConfiguration - 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:

• s3BackupConfiguration(S3DestinationConfiguration)

dataFormatConversionConfiguration

ExtendedS3DestinationConfiguration.Builder dataFormatConversionConfiguration(DataFormatConversionConfiguration dataFormatConversionConfiguration)

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

Parameters:

dataFormatConversionConfiguration - The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

Returns:

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

dataFormatConversionConfiguration

default ExtendedS3DestinationConfiguration.Builder dataFormatConversionConfiguration(Consumer<DataFormatConversionConfiguration.Builder> dataFormatConversionConfiguration)

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

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

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

Parameters:

dataFormatConversionConfiguration - a consumer that will call methods on DataFormatConversionConfiguration.Builder

Returns:

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

See Also:

• dataFormatConversionConfiguration(DataFormatConversionConfiguration)

dynamicPartitioningConfiguration

ExtendedS3DestinationConfiguration.Builder dynamicPartitioningConfiguration(DynamicPartitioningConfiguration dynamicPartitioningConfiguration)

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

Parameters:

dynamicPartitioningConfiguration - The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

Returns:

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

dynamicPartitioningConfiguration

default ExtendedS3DestinationConfiguration.Builder dynamicPartitioningConfiguration(Consumer<DynamicPartitioningConfiguration.Builder> dynamicPartitioningConfiguration)

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

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

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

Parameters:

dynamicPartitioningConfiguration - a consumer that will call methods on DynamicPartitioningConfiguration.Builder

Returns:

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

See Also:

• dynamicPartitioningConfiguration(DynamicPartitioningConfiguration)

fileExtension

ExtendedS3DestinationConfiguration.Builder fileExtension(String fileExtension)

Specify a file extension. It will override the default file extension

Parameters:

fileExtension - Specify a file extension. It will override the default file extension

Returns:

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

customTimeZone

ExtendedS3DestinationConfiguration.Builder customTimeZone(String customTimeZone)

The time zone you prefer. UTC is the default.

Parameters:

customTimeZone - The time zone you prefer. UTC is the default.

Returns:

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