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

Class DestinationS3BackupProps.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisfirehose.destinations.alpha.DestinationS3BackupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DestinationS3BackupProps>

Enclosing interface:

DestinationS3BackupProps

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

A builder for DestinationS3BackupProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DestinationS3BackupProps.Builder	bucket(IBucket bucket)	Sets the value of DestinationS3BackupProps.getBucket()
DestinationS3BackupProps.Builder	bufferingInterval(Duration bufferingInterval)	Sets the value of CommonDestinationS3Props.getBufferingInterval()
DestinationS3BackupProps.Builder	bufferingSize(Size bufferingSize)	Sets the value of CommonDestinationS3Props.getBufferingSize()
DestinationS3BackupProps	build()	Builds the configured instance.
DestinationS3BackupProps.Builder	compression(Compression compression)	Sets the value of CommonDestinationS3Props.getCompression()
DestinationS3BackupProps.Builder	dataOutputPrefix(String dataOutputPrefix)	Sets the value of CommonDestinationS3Props.getDataOutputPrefix()
DestinationS3BackupProps.Builder	encryptionKey(IKey encryptionKey)	Sets the value of CommonDestinationS3Props.getEncryptionKey()
DestinationS3BackupProps.Builder	errorOutputPrefix(String errorOutputPrefix)	Sets the value of CommonDestinationS3Props.getErrorOutputPrefix()
DestinationS3BackupProps.Builder	loggingConfig(ILoggingConfig loggingConfig)	Sets the value of DestinationS3BackupProps.getLoggingConfig()
DestinationS3BackupProps.Builder	mode(BackupMode mode)	Sets the value of DestinationS3BackupProps.getMode()

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

bucket

@Stability(Experimental)
public DestinationS3BackupProps.Builder bucket(IBucket bucket)

Sets the value of DestinationS3BackupProps.getBucket()

Parameters:

bucket - The S3 bucket that will store data and failed records.

Returns:

this

loggingConfig

@Stability(Experimental)
public DestinationS3BackupProps.Builder loggingConfig(ILoggingConfig loggingConfig)

Sets the value of DestinationS3BackupProps.getLoggingConfig()

Parameters:

loggingConfig - Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.

Returns:

this

mode

@Stability(Experimental)
public DestinationS3BackupProps.Builder mode(BackupMode mode)

Sets the value of DestinationS3BackupProps.getMode()

Parameters:

mode - Indicates the mode by which incoming records should be backed up to S3, if any. If bucket is provided, this will be implicitly set to BackupMode.ALL.

Returns:

this

bufferingInterval

@Stability(Experimental)
public DestinationS3BackupProps.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(0) Maximum: Duration.seconds(900)

Returns:

this

bufferingSize

@Stability(Experimental)
public DestinationS3BackupProps.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 DestinationS3BackupProps.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 DestinationS3BackupProps.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 DestinationS3BackupProps.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 DestinationS3BackupProps.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 DestinationS3BackupProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DestinationS3BackupProps

Throws:

NullPointerException - if any required attribute was not provided