java.lang.Object
- software.amazon.awssdk.services.firehose.model.ExtendedS3DestinationConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ExtendedS3DestinationConfiguration.Builder,ExtendedS3DestinationConfiguration>

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

Describes the configuration of a destination in Amazon S3.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ExtendedS3DestinationConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`bucketARN()`	The ARN of the S3 bucket.
`BufferingHints`	`bufferingHints()`	The buffering option.
`static ExtendedS3DestinationConfiguration.Builder`	`builder()`
`CloudWatchLoggingOptions`	`cloudWatchLoggingOptions()`	The Amazon CloudWatch logging options for your delivery stream.
`CompressionFormat`	`compressionFormat()`	The compression format.
`String`	`compressionFormatAsString()`	The compression format.
`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`	`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`	`encryptionConfiguration()`	The encryption configuration.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`errorOutputPrefix()`	A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
`<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.
`ProcessingConfiguration`	`processingConfiguration()`	The data processing configuration.
`String`	`roleARN()`	The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
`S3DestinationConfiguration`	`s3BackupConfiguration()`	The configuration for backup in Amazon S3.
`S3BackupMode`	`s3BackupMode()`	The Amazon S3 backup mode.
`String`	`s3BackupModeAsString()`	The Amazon S3 backup mode.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ExtendedS3DestinationConfiguration.Builder>`	`serializableBuilderClass()`
`ExtendedS3DestinationConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - roleARN
```
public final 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.
    
    Returns:
    
    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.
  - bucketARN
```
public final String bucketARN()
```
    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Returns:
    
    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
  - prefix
```
public final 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.
    
    Returns:
    
    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.
  - errorOutputPrefix
```
public final 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.
    
    Returns:
    
    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.
  - bufferingHints
```
public final BufferingHints bufferingHints()
```
    The buffering option.
    
    Returns:
    
    The buffering option.
  - compressionFormat
```
public final CompressionFormat compressionFormat()
```
    The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    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.
    
    See Also:
    
    CompressionFormat
  - compressionFormatAsString
```
public final String compressionFormatAsString()
```
    The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    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.
    
    See Also:
    
    CompressionFormat
  - encryptionConfiguration
```
public final 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 final CloudWatchLoggingOptions cloudWatchLoggingOptions()
```
    The Amazon CloudWatch logging options for your delivery stream.
    
    Returns:
    
    The Amazon CloudWatch logging options for your delivery stream.
  - processingConfiguration
```
public final ProcessingConfiguration processingConfiguration()
```
    The data processing configuration.
    
    Returns:
    
    The data processing configuration.
  - s3BackupMode
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return S3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    S3BackupMode
  - s3BackupModeAsString
```
public final String s3BackupModeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return S3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    S3BackupMode
  - s3BackupConfiguration
```
public final S3DestinationConfiguration s3BackupConfiguration()
```
    The configuration for backup in Amazon S3.
    
    Returns:
    
    The configuration for backup in Amazon S3.
  - dataFormatConversionConfiguration
```
public final 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.
    
    Returns:
    
    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
```
public final 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.
    
    Returns:
    
    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.
  - toBuilder
```
public ExtendedS3DestinationConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ExtendedS3DestinationConfiguration.Builder,ExtendedS3DestinationConfiguration>
  - builder
```
public static ExtendedS3DestinationConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ExtendedS3DestinationConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ExtendedS3DestinationConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

roleARN

bucketARN

prefix

errorOutputPrefix

bufferingHints

compressionFormat

compressionFormatAsString

encryptionConfiguration

cloudWatchLoggingOptions

processingConfiguration

s3BackupMode

s3BackupModeAsString

s3BackupConfiguration

dataFormatConversionConfiguration

dynamicPartitioningConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields