software.amazon.awssdk.services.firehose.model

Class S3DestinationConfiguration

java.lang.Object

software.amazon.awssdk.services.firehose.model.S3DestinationConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class S3DestinationConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>

Describes the configuration of a destination in Amazon S3.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	S3DestinationConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
String	bucketARN() The ARN of the S3 bucket.
BufferingHints	bufferingHints() The buffering option.
static S3DestinationConfiguration.Builder	builder()
CloudWatchLoggingOptions	cloudWatchLoggingOptions() The CloudWatch logging options for your delivery stream.
CompressionFormat	compressionFormat() The compression format.
String	compressionFormatAsString() The compression format.
EncryptionConfiguration	encryptionConfiguration() The encryption configuration.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	prefix() The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.
String	roleARN() The Amazon Resource Name (ARN) of the AWS credentials.
List<SdkField<?>>	sdkFields()
static Class<? extends S3DestinationConfiguration.Builder>	serializableBuilderClass()
S3DestinationConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

roleARN

public String roleARN()

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

Returns:

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

bucketARN

public String bucketARN()

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

Returns:

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

prefix

public String prefix()

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

Returns:

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

bufferingHints

public BufferingHints bufferingHints()

The buffering option. If no value is specified, BufferingHints object default values are used.

Returns:

The buffering option. If no value is specified, BufferingHints object default values are used.

compressionFormat

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

If the service returns an enum value that is not available in the current SDK version, compressionFormat will return CompressionFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionFormatAsString().

Returns:

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.

See Also:

CompressionFormat

compressionFormatAsString

public String compressionFormatAsString()

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.

If the service returns an enum value that is not available in the current SDK version, compressionFormat will return CompressionFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionFormatAsString().

Returns:

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.

See Also:

CompressionFormat

encryptionConfiguration

public EncryptionConfiguration encryptionConfiguration()

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

Returns:

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

cloudWatchLoggingOptions

public CloudWatchLoggingOptions cloudWatchLoggingOptions()

The CloudWatch logging options for your delivery stream.

Returns:

The CloudWatch logging options for your delivery stream.

toBuilder

public S3DestinationConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>

Returns:

a builder for type T

builder

public static S3DestinationConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends S3DestinationConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.