Interface S3DestinationConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<S3DestinationConfiguration.Builder,
,S3DestinationConfiguration> SdkBuilder<S3DestinationConfiguration.Builder,
,S3DestinationConfiguration> SdkPojo
- Enclosing class:
S3DestinationConfiguration
-
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 CloudWatch logging options for your delivery stream.cloudWatchLoggingOptions
(CloudWatchLoggingOptions cloudWatchLoggingOptions) The CloudWatch logging options for your delivery stream.compressionFormat
(String compressionFormat) The compression format.compressionFormat
(CompressionFormat compressionFormat) The compression format.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.The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.The Amazon Resource Name (ARN) of the Amazon Web Services credentials.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. If no value is specified,
BufferingHints
object default values are used.- Parameters:
bufferingHints
- The buffering option. If no value is specified,BufferingHints
object default values are used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bufferingHints
default S3DestinationConfiguration.Builder bufferingHints(Consumer<BufferingHints.Builder> bufferingHints) The buffering option. If no value is specified,
This is a convenience method that creates an instance of theBufferingHints
object default values are used.BufferingHints.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
.The compression formats
SNAPPY
orZIP
cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPY
operation that reads from the S3 bucket.- Parameters:
compressionFormat
- The compression format. If no value is specified, the default isUNCOMPRESSED
.The compression formats
SNAPPY
orZIP
cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPY
operation that reads from the S3 bucket.- 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
.The compression formats
SNAPPY
orZIP
cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPY
operation that reads from the S3 bucket.- Parameters:
compressionFormat
- The compression format. If no value is specified, the default isUNCOMPRESSED
.The compression formats
SNAPPY
orZIP
cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPY
operation that reads from the S3 bucket.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
encryptionConfiguration
S3DestinationConfiguration.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 S3DestinationConfiguration.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
S3DestinationConfiguration.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) The CloudWatch logging options for your delivery stream.
- Parameters:
cloudWatchLoggingOptions
- The CloudWatch logging options for your delivery stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cloudWatchLoggingOptions
default S3DestinationConfiguration.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) The 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:
-