Package software.amazon.awscdk.services.kinesisfirehose.destinations

Class CommonDestinationS3Props.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisfirehose.destinations.CommonDestinationS3Props.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CommonDestinationS3Props>

Enclosing interface:

CommonDestinationS3Props

@Stability(Experimental)
public static final class CommonDestinationS3Props.Builder
extends Object
implements software.amazon.jsii.Builder<CommonDestinationS3Props>

A builder for CommonDestinationS3Props

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CommonDestinationS3Props.Builder	bufferingInterval(Duration bufferingInterval)	Sets the value of CommonDestinationS3Props.getBufferingInterval()
CommonDestinationS3Props.Builder	bufferingSize(Size bufferingSize)	Sets the value of CommonDestinationS3Props.getBufferingSize()
CommonDestinationS3Props	build()	Builds the configured instance.
CommonDestinationS3Props.Builder	compression(Compression compression)	Sets the value of CommonDestinationS3Props.getCompression()
CommonDestinationS3Props.Builder	dataOutputPrefix(String dataOutputPrefix)	Sets the value of CommonDestinationS3Props.getDataOutputPrefix()
CommonDestinationS3Props.Builder	encryptionKey(IKey encryptionKey)	Sets the value of CommonDestinationS3Props.getEncryptionKey()
CommonDestinationS3Props.Builder	errorOutputPrefix(String errorOutputPrefix)	Sets the value of CommonDestinationS3Props.getErrorOutputPrefix()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

bufferingInterval

@Stability(Experimental)
public CommonDestinationS3Props.Builder bufferingInterval(Duration bufferingInterval)

Sets the value of CommonDestinationS3Props.getBufferingInterval()

Parameters:

bufferingInterval - The length of time that Firehose buffers incoming data before delivering it to the S3 bucket. Minimum: Duration.seconds(60) Maximum: Duration.seconds(900)

Returns:

this

bufferingSize

@Stability(Experimental)
public CommonDestinationS3Props.Builder bufferingSize(Size bufferingSize)

Sets the value of CommonDestinationS3Props.getBufferingSize()

Parameters:

bufferingSize - The size of the buffer that Kinesis Data Firehose uses for incoming data before delivering it to the S3 bucket. Minimum: Size.mebibytes(1) Maximum: Size.mebibytes(128)

Returns:

this

compression

@Stability(Experimental)
public CommonDestinationS3Props.Builder compression(Compression compression)

Sets the value of CommonDestinationS3Props.getCompression()

Parameters:

compression - The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. 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:

this

dataOutputPrefix

@Stability(Experimental)
public CommonDestinationS3Props.Builder dataOutputPrefix(String dataOutputPrefix)

Sets the value of CommonDestinationS3Props.getDataOutputPrefix()

Parameters:

dataOutputPrefix - A prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3. This prefix appears immediately following the bucket name.

Returns:

this

encryptionKey

@Stability(Experimental)
public CommonDestinationS3Props.Builder encryptionKey(IKey encryptionKey)

Sets the value of CommonDestinationS3Props.getEncryptionKey()

Parameters:

encryptionKey - The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.

Returns:

this

errorOutputPrefix

@Stability(Experimental)
public CommonDestinationS3Props.Builder errorOutputPrefix(String errorOutputPrefix)

Sets the value of CommonDestinationS3Props.getErrorOutputPrefix()

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:

this

build

@Stability(Experimental)
public CommonDestinationS3Props build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CommonDestinationS3Props>

Returns:

a new instance of CommonDestinationS3Props

Throws:

NullPointerException - if any required attribute was not provided