Interface ExtendedS3DestinationDescription.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ExtendedS3DestinationDescription.Builder,
,ExtendedS3DestinationDescription> SdkBuilder<ExtendedS3DestinationDescription.Builder,
,ExtendedS3DestinationDescription> SdkPojo
- Enclosing class:
ExtendedS3DestinationDescription
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the S3 bucket.bufferingHints
(Consumer<BufferingHints.Builder> bufferingHints) The buffering option.bufferingHints
(BufferingHints bufferingHints) The buffering option.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.compressionFormat
(String compressionFormat) The compression format.compressionFormat
(CompressionFormat compressionFormat) The compression format.customTimeZone
(String customTimeZone) The time zone you prefer.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.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.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.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.encryptionConfiguration
(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration) The encryption configuration.encryptionConfiguration
(EncryptionConfiguration encryptionConfiguration) The encryption configuration.errorOutputPrefix
(String errorOutputPrefix) A prefix that Firehose evaluates and adds to failed records before writing them to S3.fileExtension
(String fileExtension) Specify a file extension.The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.processingConfiguration
(Consumer<ProcessingConfiguration.Builder> processingConfiguration) The data processing configuration.processingConfiguration
(ProcessingConfiguration processingConfiguration) The data processing configuration.The Amazon Resource Name (ARN) of the Amazon Web Services credentials.s3BackupDescription
(Consumer<S3DestinationDescription.Builder> s3BackupDescription) The configuration for backup in Amazon S3.s3BackupDescription
(S3DestinationDescription s3BackupDescription) The configuration for backup in Amazon S3.s3BackupMode
(String s3BackupMode) The Amazon S3 backup mode.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
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
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
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
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
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 ExtendedS3DestinationDescription.Builder bufferingHints(Consumer<BufferingHints.Builder> bufferingHints) The buffering option.
This is a convenience method that creates an instance of theBufferingHints.Builder
avoiding the need to create one manually viaBufferingHints.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobufferingHints(BufferingHints)
.- Parameters:
bufferingHints
- a consumer that will call methods onBufferingHints.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isUNCOMPRESSED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isUNCOMPRESSED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
encryptionConfiguration
ExtendedS3DestinationDescription.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 ExtendedS3DestinationDescription.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 theEncryptionConfiguration.Builder
avoiding the need to create one manually viaEncryptionConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionConfiguration(EncryptionConfiguration)
.- Parameters:
encryptionConfiguration
- a consumer that will call methods onEncryptionConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cloudWatchLoggingOptions
ExtendedS3DestinationDescription.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 ExtendedS3DestinationDescription.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:
-
processingConfiguration
ExtendedS3DestinationDescription.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 ExtendedS3DestinationDescription.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:
-
s3BackupMode
The Amazon S3 backup mode.
- Parameters:
s3BackupMode
- The Amazon S3 backup mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3BackupMode
The Amazon S3 backup mode.
- Parameters:
s3BackupMode
- The Amazon S3 backup mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
s3BackupDescription
ExtendedS3DestinationDescription.Builder s3BackupDescription(S3DestinationDescription s3BackupDescription) The configuration for backup in Amazon S3.
- Parameters:
s3BackupDescription
- The configuration for backup in Amazon S3.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3BackupDescription
default ExtendedS3DestinationDescription.Builder s3BackupDescription(Consumer<S3DestinationDescription.Builder> s3BackupDescription) The configuration for backup in Amazon S3.
This is a convenience method that creates an instance of theS3DestinationDescription.Builder
avoiding the need to create one manually viaS3DestinationDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3BackupDescription(S3DestinationDescription)
.- Parameters:
s3BackupDescription
- a consumer that will call methods onS3DestinationDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataFormatConversionConfiguration
ExtendedS3DestinationDescription.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 ExtendedS3DestinationDescription.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 theDataFormatConversionConfiguration.Builder
avoiding the need to create one manually viaDataFormatConversionConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataFormatConversionConfiguration(DataFormatConversionConfiguration)
.- Parameters:
dataFormatConversionConfiguration
- a consumer that will call methods onDataFormatConversionConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dynamicPartitioningConfiguration
ExtendedS3DestinationDescription.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 ExtendedS3DestinationDescription.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 theDynamicPartitioningConfiguration.Builder
avoiding the need to create one manually viaDynamicPartitioningConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todynamicPartitioningConfiguration(DynamicPartitioningConfiguration)
.- Parameters:
dynamicPartitioningConfiguration
- a consumer that will call methods onDynamicPartitioningConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
-