com.amazonaws.services.kinesisfirehose.model

Class S3DestinationConfiguration

java.lang.Object

com.amazonaws.services.kinesisfirehose.model.S3DestinationConfiguration

All Implemented Interfaces:

Serializable, Cloneable

public class S3DestinationConfiguration
extends Object
implements Serializable, Cloneable

Describes the configuration of a destination in Amazon S3.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
S3DestinationConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
S3DestinationConfiguration	clone()
boolean	equals(Object obj)
String	getBucketARN() The ARN of the S3 bucket.
BufferingHints	getBufferingHints() The buffering option.
String	getCompressionFormat() The compression format.
EncryptionConfiguration	getEncryptionConfiguration() The encryption configuration.
String	getPrefix() The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files.
String	getRoleARN() The ARN of the AWS credentials.
int	hashCode()
void	setBucketARN(String bucketARN) The ARN of the S3 bucket.
void	setBufferingHints(BufferingHints bufferingHints) The buffering option.
void	setCompressionFormat(CompressionFormat compressionFormat) The compression format.
void	setCompressionFormat(String compressionFormat) The compression format.
void	setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration) The encryption configuration.
void	setPrefix(String prefix) The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files.
void	setRoleARN(String roleARN) The ARN of the AWS credentials.
String	toString() Returns a string representation of this object; useful for testing and debugging.
S3DestinationConfiguration	withBucketARN(String bucketARN) The ARN of the S3 bucket.
S3DestinationConfiguration	withBufferingHints(BufferingHints bufferingHints) The buffering option.
S3DestinationConfiguration	withCompressionFormat(CompressionFormat compressionFormat) The compression format.
S3DestinationConfiguration	withCompressionFormat(String compressionFormat) The compression format.
S3DestinationConfiguration	withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration) The encryption configuration.
S3DestinationConfiguration	withPrefix(String prefix) The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files.
S3DestinationConfiguration	withRoleARN(String roleARN) The ARN of the AWS credentials.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

S3DestinationConfiguration

public S3DestinationConfiguration()

Method Detail

setRoleARN

public void setRoleARN(String roleARN)

The ARN of the AWS credentials.

Parameters:

roleARN - The ARN of the AWS credentials.

getRoleARN

public String getRoleARN()

The ARN of the AWS credentials.

Returns:

The ARN of the AWS credentials.

withRoleARN

public S3DestinationConfiguration withRoleARN(String roleARN)

The ARN of the AWS credentials.

Parameters:

roleARN - The ARN of the AWS credentials.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBucketARN

public void setBucketARN(String bucketARN)

The ARN of the S3 bucket.

Parameters:

bucketARN - The ARN of the S3 bucket.

getBucketARN

public String getBucketARN()

The ARN of the S3 bucket.

Returns:

The ARN of the S3 bucket.

withBucketARN

public S3DestinationConfiguration withBucketARN(String bucketARN)

The ARN of the S3 bucket.

Parameters:

bucketARN - The ARN of the S3 bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPrefix

public void setPrefix(String prefix)

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that 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 guide-fh-dev.

Parameters:

prefix - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that 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 guide-fh-dev.

getPrefix

public String getPrefix()

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that 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 guide-fh-dev.

Returns:

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that 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 guide-fh-dev.

withPrefix

public S3DestinationConfiguration withPrefix(String prefix)

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that 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 guide-fh-dev.

Parameters:

prefix - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that 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 guide-fh-dev.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBufferingHints

public void setBufferingHints(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.

getBufferingHints

public BufferingHints getBufferingHints()

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.

withBufferingHints

public S3DestinationConfiguration withBufferingHints(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.

setCompressionFormat

public void setCompressionFormat(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.

See Also:

CompressionFormat

getCompressionFormat

public String getCompressionFormat()

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:

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

withCompressionFormat

public S3DestinationConfiguration withCompressionFormat(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

setCompressionFormat

public void setCompressionFormat(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.

See Also:

CompressionFormat

withCompressionFormat

public S3DestinationConfiguration withCompressionFormat(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

setEncryptionConfiguration

public void setEncryptionConfiguration(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.

getEncryptionConfiguration

public EncryptionConfiguration getEncryptionConfiguration()

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.

withEncryptionConfiguration

public S3DestinationConfiguration withEncryptionConfiguration(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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public S3DestinationConfiguration clone()

Overrides:

clone in class Object