Class S3BucketProps.Builder
java.lang.Object
software.amazon.awscdk.services.kinesisfirehose.destinations.alpha.S3BucketProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<S3BucketProps>
- Enclosing interface:
S3BucketProps
@Stability(Experimental)
public static final class S3BucketProps.Builder
extends Object
implements software.amazon.jsii.Builder<S3BucketProps>
A builder for
S3BucketProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbufferingInterval
(Duration bufferingInterval) Sets the value ofCommonDestinationS3Props.getBufferingInterval()
bufferingSize
(Size bufferingSize) Sets the value ofCommonDestinationS3Props.getBufferingSize()
build()
Builds the configured instance.compression
(Compression compression) Sets the value ofCommonDestinationS3Props.getCompression()
dataOutputPrefix
(String dataOutputPrefix) Sets the value ofCommonDestinationS3Props.getDataOutputPrefix()
encryptionKey
(IKey encryptionKey) Sets the value ofCommonDestinationS3Props.getEncryptionKey()
errorOutputPrefix
(String errorOutputPrefix) Sets the value ofCommonDestinationS3Props.getErrorOutputPrefix()
Sets the value ofCommonDestinationProps.getLogging()
Sets the value ofCommonDestinationProps.getLogGroup()
processor
(IDataProcessor processor) Sets the value ofCommonDestinationProps.getProcessor()
Sets the value ofCommonDestinationProps.getRole()
s3Backup
(DestinationS3BackupProps s3Backup) Sets the value ofCommonDestinationProps.getS3Backup()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
bufferingInterval
Sets the value ofCommonDestinationS3Props.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
Sets the value ofCommonDestinationS3Props.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
Sets the value ofCommonDestinationS3Props.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
Sets the value ofCommonDestinationS3Props.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
Sets the value ofCommonDestinationS3Props.getEncryptionKey()
- Parameters:
encryptionKey
- The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.- Returns:
this
-
errorOutputPrefix
Sets the value ofCommonDestinationS3Props.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
-
logging
Sets the value ofCommonDestinationProps.getLogging()
- Parameters:
logging
- If true, log errors when data transformation or data delivery fails. IflogGroup
is provided, this will be implicitly set totrue
.- Returns:
this
-
logGroup
Sets the value ofCommonDestinationProps.getLogGroup()
- Parameters:
logGroup
- The CloudWatch log group where log streams will be created to hold error logs.- Returns:
this
-
processor
Sets the value ofCommonDestinationProps.getProcessor()
- Parameters:
processor
- The data transformation that should be performed on the data before writing to the destination.- Returns:
this
-
role
Sets the value ofCommonDestinationProps.getRole()
- Parameters:
role
- The IAM role associated with this destination. Assumed by Kinesis Data Firehose to invoke processors and write to destinations- Returns:
this
-
s3Backup
Sets the value ofCommonDestinationProps.getS3Backup()
- Parameters:
s3Backup
- The configuration for backing up source records to S3.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<S3BucketProps>
- Returns:
- a new instance of
S3BucketProps
- Throws:
NullPointerException
- if any required attribute was not provided
-