Package software.amazon.awscdk.services.kinesisfirehose

Class S3BucketProps.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisfirehose.S3BucketProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<S3BucketProps>

Enclosing interface:

S3BucketProps

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

A builder for S3BucketProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
S3BucketProps.Builder	bufferingInterval(Duration bufferingInterval)	Sets the value of CommonDestinationS3Props.getBufferingInterval()
S3BucketProps.Builder	bufferingSize(Size bufferingSize)	Sets the value of CommonDestinationS3Props.getBufferingSize()
S3BucketProps	build()	Builds the configured instance.
S3BucketProps.Builder	compression(Compression compression)	Sets the value of CommonDestinationS3Props.getCompression()
S3BucketProps.Builder	dataFormatConversion(DataFormatConversionProps dataFormatConversion)	Sets the value of S3BucketProps.getDataFormatConversion()
S3BucketProps.Builder	dataOutputPrefix(String dataOutputPrefix)	Sets the value of CommonDestinationS3Props.getDataOutputPrefix()
S3BucketProps.Builder	encryptionKey(IKey encryptionKey)	Sets the value of CommonDestinationS3Props.getEncryptionKey()
S3BucketProps.Builder	errorOutputPrefix(String errorOutputPrefix)	Sets the value of CommonDestinationS3Props.getErrorOutputPrefix()
S3BucketProps.Builder	fileExtension(String fileExtension)	Sets the value of S3BucketProps.getFileExtension()
S3BucketProps.Builder	loggingConfig(ILoggingConfig loggingConfig)	Sets the value of CommonDestinationProps.getLoggingConfig()
S3BucketProps.Builder	processor(IDataProcessor processor)	Deprecated. Use `processors` instead.
S3BucketProps.Builder	processors(List<? extends IDataProcessor> processors)	Sets the value of CommonDestinationProps.getProcessors()
S3BucketProps.Builder	role(IRole role)	Sets the value of CommonDestinationProps.getRole()
S3BucketProps.Builder	s3Backup(DestinationS3BackupProps s3Backup)	Sets the value of CommonDestinationProps.getS3Backup()
S3BucketProps.Builder	timeZone(TimeZone timeZone)	Sets the value of S3BucketProps.getTimeZone()

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

dataFormatConversion

@Stability(Stable)
public S3BucketProps.Builder dataFormatConversion(DataFormatConversionProps dataFormatConversion)

Sets the value of S3BucketProps.getDataFormatConversion()

Parameters:

dataFormatConversion - The input format, output format, and schema config for converting data from the JSON format to the Parquet or ORC format before writing to Amazon S3.

Returns:

this

fileExtension

@Stability(Stable)
public S3BucketProps.Builder fileExtension(String fileExtension)

Sets the value of S3BucketProps.getFileExtension()

Parameters:

fileExtension - Specify a file extension. It will override the default file extension appended by Data Format Conversion or S3 compression features such as .parquet or .gz.

File extension must start with a period (.) and can contain allowed characters: 0-9a-z!-_.*'().

Returns:

this

timeZone

@Stability(Stable)
public S3BucketProps.Builder timeZone(TimeZone timeZone)

Sets the value of S3BucketProps.getTimeZone()

Parameters:

timeZone - The time zone you prefer.

Returns:

this

bufferingInterval

@Stability(Stable)
public S3BucketProps.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(Stable)
public S3BucketProps.Builder bufferingSize(Size bufferingSize)

Sets the value of CommonDestinationS3Props.getBufferingSize()

Parameters:

bufferingSize - The size of the buffer that Amazon Data Firehose uses for incoming data before delivering it to the S3 bucket. Minimum: Size.mebibytes(1) when record data format conversion is disabled, Size.mebibytes(64) when it is enabled Maximum: Size.mebibytes(128)

Returns:

this

compression

@Stability(Stable)
public S3BucketProps.Builder compression(Compression compression)

Sets the value of CommonDestinationS3Props.getCompression()

Parameters:

compression - The type of compression that Amazon 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(Stable)
public S3BucketProps.Builder dataOutputPrefix(String dataOutputPrefix)

Sets the value of CommonDestinationS3Props.getDataOutputPrefix()

Parameters:

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

Returns:

this

encryptionKey

@Stability(Stable)
public S3BucketProps.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(Stable)
public S3BucketProps.Builder errorOutputPrefix(String errorOutputPrefix)

Sets the value of CommonDestinationS3Props.getErrorOutputPrefix()

Parameters:

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

Returns:

this

loggingConfig

@Stability(Stable)
public S3BucketProps.Builder loggingConfig(ILoggingConfig loggingConfig)

Sets the value of CommonDestinationProps.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

processor

@Stability(Deprecated)
@Deprecated
public S3BucketProps.Builder processor(IDataProcessor processor)

Deprecated.

Use `processors` instead.

Sets the value of CommonDestinationProps.getProcessor()

Parameters:

processor - The data transformation that should be performed on the data before writing to the destination.

Returns:

this

processors

@Stability(Stable)
public S3BucketProps.Builder processors(List<? extends IDataProcessor> processors)

Sets the value of CommonDestinationProps.getProcessors()

Parameters:

processors - The data transformation that should be performed on the data before writing to the destination.

Returns:

this

role

@Stability(Stable)
public S3BucketProps.Builder role(IRole role)

Sets the value of CommonDestinationProps.getRole()

Parameters:

role - The IAM role associated with this destination. Assumed by Amazon Data Firehose to invoke processors and write to destinations

Returns:

this

s3Backup

@Stability(Stable)
public S3BucketProps.Builder s3Backup(DestinationS3BackupProps s3Backup)

Sets the value of CommonDestinationProps.getS3Backup()

Parameters:

s3Backup - The configuration for backing up source records to S3.

Returns:

this

build

@Stability(Stable)
public S3BucketProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of S3BucketProps

Throws:

NullPointerException - if any required attribute was not provided