Package software.amazon.awscdk.services.kinesisfirehose

Interface CommonDestinationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

S3BucketProps

All Known Implementing Classes:

CommonDestinationProps.Jsii$Proxy, S3BucketProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:54.636Z")
@Stability(Stable)
public interface CommonDestinationProps
extends software.amazon.jsii.JsiiSerializable

Generic properties for defining a delivery stream destination.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.kinesisfirehose.*;
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.s3.*;
 Bucket bucket;
 Compression compression;
 IDataProcessor dataProcessor;
 Key key;
 ILoggingConfig loggingConfig;
 Role role;
 Size size;
 CommonDestinationProps commonDestinationProps = CommonDestinationProps.builder()
         .loggingConfig(loggingConfig)
         .processor(dataProcessor)
         .processors(List.of(dataProcessor))
         .role(role)
         .s3Backup(DestinationS3BackupProps.builder()
                 .bucket(bucket)
                 .bufferingInterval(Duration.minutes(30))
                 .bufferingSize(size)
                 .compression(compression)
                 .dataOutputPrefix("dataOutputPrefix")
                 .encryptionKey(key)
                 .errorOutputPrefix("errorOutputPrefix")
                 .loggingConfig(loggingConfig)
                 .mode(BackupMode.ALL)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CommonDestinationProps.Builder	A builder for CommonDestinationProps
static final class	CommonDestinationProps.Jsii$Proxy	An implementation for CommonDestinationProps

Method Summary

Modifier and Type	Method	Description
static CommonDestinationProps.Builder	builder()
default ILoggingConfig	getLoggingConfig()	Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.
default IDataProcessor	getProcessor()	Deprecated. Use processors instead.
default List<IDataProcessor>	getProcessors()	The data transformation that should be performed on the data before writing to the destination.
default IRole	getRole()	The IAM role associated with this destination.
default DestinationS3BackupProps	getS3Backup()	The configuration for backing up source records to S3.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLoggingConfig

@Stability(Stable)
@Nullable
default ILoggingConfig getLoggingConfig()

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

Default: - errors will be logged and a log group will be created for you.

getProcessor

@Stability(Deprecated)
@Deprecated
@Nullable
default IDataProcessor getProcessor()

Deprecated.

Use processors instead.

(deprecated) The data transformation that should be performed on the data before writing to the destination.

Default: - no data transformation will occur.

getProcessors

@Stability(Stable)
@Nullable
default List<IDataProcessor> getProcessors()

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

Default: - no data transformation will occur.

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

The IAM role associated with this destination.

Assumed by Amazon Data Firehose to invoke processors and write to destinations

Default: - a role will be created with default permissions.

getS3Backup

@Stability(Stable)
@Nullable
default DestinationS3BackupProps getS3Backup()

The configuration for backing up source records to S3.

Default: - source records will not be backed up to S3.

builder

@Stability(Stable)
static CommonDestinationProps.Builder builder()

Returns:

a CommonDestinationProps.Builder of CommonDestinationProps