com.amazonaws.services.kinesisfirehose.model

Class S3DestinationUpdate

java.lang.Object

com.amazonaws.services.kinesisfirehose.model.S3DestinationUpdate

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class S3DestinationUpdate
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes an update for a destination in Amazon S3.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
S3DestinationUpdate()

Method Summary

Modifier and Type	Method and Description
S3DestinationUpdate	clone()
boolean	equals(Object obj)
String	getBucketARN() The ARN of the S3 bucket.
BufferingHints	getBufferingHints() The buffering option.
CloudWatchLoggingOptions	getCloudWatchLoggingOptions() The CloudWatch logging options for your delivery stream.
String	getCompressionFormat() The compression format.
EncryptionConfiguration	getEncryptionConfiguration() The encryption configuration.
String	getErrorOutputPrefix() A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
String	getPrefix() The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.
String	getRoleARN() The Amazon Resource Name (ARN) of the AWS credentials.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setBucketARN(String bucketARN) The ARN of the S3 bucket.
void	setBufferingHints(BufferingHints bufferingHints) The buffering option.
void	setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) The CloudWatch logging options for your delivery stream.
void	setCompressionFormat(CompressionFormat compressionFormat) The compression format.
void	setCompressionFormat(String compressionFormat) The compression format.
void	setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration) The encryption configuration.
void	setErrorOutputPrefix(String errorOutputPrefix) A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
void	setPrefix(String prefix) The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.
void	setRoleARN(String roleARN) The Amazon Resource Name (ARN) of the AWS credentials.
String	toString() Returns a string representation of this object.
S3DestinationUpdate	withBucketARN(String bucketARN) The ARN of the S3 bucket.
S3DestinationUpdate	withBufferingHints(BufferingHints bufferingHints) The buffering option.
S3DestinationUpdate	withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) The CloudWatch logging options for your delivery stream.
S3DestinationUpdate	withCompressionFormat(CompressionFormat compressionFormat) The compression format.
S3DestinationUpdate	withCompressionFormat(String compressionFormat) The compression format.
S3DestinationUpdate	withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration) The encryption configuration.
S3DestinationUpdate	withErrorOutputPrefix(String errorOutputPrefix) A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
S3DestinationUpdate	withPrefix(String prefix) The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.
S3DestinationUpdate	withRoleARN(String roleARN) The Amazon Resource Name (ARN) of the AWS credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

S3DestinationUpdate

public S3DestinationUpdate()

Method Detail

setRoleARN

public void setRoleARN(String roleARN)

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

Parameters:

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

getRoleARN

public String getRoleARN()

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.

withRoleARN

public S3DestinationUpdate withRoleARN(String roleARN)

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

Parameters:

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

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. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Parameters:

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

getBucketARN

public String getBucketARN()

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.

withBucketARN

public S3DestinationUpdate withBucketARN(String bucketARN)

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

Parameters:

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

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

Parameters:

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.

getPrefix

public String getPrefix()

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.

withPrefix

public S3DestinationUpdate withPrefix(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.

Parameters:

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:

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

setErrorOutputPrefix

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

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.

getErrorOutputPrefix

public String getErrorOutputPrefix()

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.

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.

withErrorOutputPrefix

public S3DestinationUpdate withErrorOutputPrefix(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.

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.

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

setCloudWatchLoggingOptions

public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

The CloudWatch logging options for your delivery stream.

Parameters:

cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.

getCloudWatchLoggingOptions

public CloudWatchLoggingOptions getCloudWatchLoggingOptions()

The CloudWatch logging options for your delivery stream.

Returns:

The CloudWatch logging options for your delivery stream.

withCloudWatchLoggingOptions

public S3DestinationUpdate withCloudWatchLoggingOptions(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.

toString

public 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

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 S3DestinationUpdate clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo