software.amazon.awssdk.services.firehose.model

Interface S3DestinationConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

S3DestinationConfiguration

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

Method Summary

Modifier and Type	Method and Description
S3DestinationConfiguration.Builder	bucketARN(String bucketARN) The ARN of the S3 bucket.
S3DestinationConfiguration.Builder	bufferingHints(BufferingHints bufferingHints) The buffering option.
default S3DestinationConfiguration.Builder	bufferingHints(Consumer<BufferingHints.Builder> bufferingHints) The buffering option.
S3DestinationConfiguration.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) The CloudWatch logging options for your delivery stream.
default S3DestinationConfiguration.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions) The CloudWatch logging options for your delivery stream.
S3DestinationConfiguration.Builder	compressionFormat(CompressionFormat compressionFormat) The compression format.
S3DestinationConfiguration.Builder	compressionFormat(String compressionFormat) The compression format.
default S3DestinationConfiguration.Builder	encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration) The encryption configuration.
S3DestinationConfiguration.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration) The encryption configuration.
S3DestinationConfiguration.Builder	errorOutputPrefix(String errorOutputPrefix) A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
S3DestinationConfiguration.Builder	prefix(String prefix) The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.
S3DestinationConfiguration.Builder	roleARN(String roleARN) The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

roleARN

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

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

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

S3DestinationConfiguration.Builder errorOutputPrefix(String errorOutputPrefix)

A prefix that Kinesis Data 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 Kinesis Data 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

S3DestinationConfiguration.Builder bufferingHints(BufferingHints 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, BufferingHints object default values are used.

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

S3DestinationConfiguration.Builder compressionFormat(String compressionFormat)

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

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

Parameters:

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

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY 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, CompressionFormat

compressionFormat

S3DestinationConfiguration.Builder compressionFormat(CompressionFormat compressionFormat)

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

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

Parameters:

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

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY 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, CompressionFormat

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

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