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

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.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.943Z") @Stability(Experimental) public interface CommonDestinationProps extends software.amazon.jsii.JsiiSerializable
(experimental) 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.services.iam.*;
 import software.amazon.awscdk.services.kinesisfirehose.*;
 import software.amazon.awscdk.services.kinesisfirehose.destinations.*;
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.core.*;
 Bucket bucket;
 Compression compression;
 IDataProcessor dataProcessor;
 Key key;
 LogGroup logGroup;
 Role role;
 Size size;
 CommonDestinationProps commonDestinationProps = CommonDestinationProps.builder()
         .logging(false)
         .logGroup(logGroup)
         .processor(dataProcessor)
         .role(role)
         .s3Backup(DestinationS3BackupProps.builder()
                 .bucket(bucket)
                 .bufferingInterval(Duration.minutes(30))
                 .bufferingSize(size)
                 .compression(compression)
                 .dataOutputPrefix("dataOutputPrefix")
                 .encryptionKey(key)
                 .errorOutputPrefix("errorOutputPrefix")
                 .logging(false)
                 .logGroup(logGroup)
                 .mode(BackupMode.ALL)
                 .build())
         .build();

  • Method Details

    • getLogging

      @Stability(Experimental) @Nullable default Boolean getLogging()
      (experimental) If true, log errors when data transformation or data delivery fails.

      If logGroup is provided, this will be implicitly set to true.

      Default: true - errors are logged.

    • getLogGroup

      @Stability(Experimental) @Nullable default ILogGroup getLogGroup()
      (experimental) The CloudWatch log group where log streams will be created to hold error logs.

      Default: - if `logging` is set to `true`, a log group will be created for you.

    • getProcessor

      @Stability(Experimental) @Nullable default IDataProcessor getProcessor()
      (experimental) The data transformation that should be performed on the data before writing to the destination.

      Default: - no data transformation will occur.

    • getRole

      @Stability(Experimental) @Nullable default IRole getRole()
      (experimental) The IAM role associated with this destination.

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

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

    • getS3Backup

      @Stability(Experimental) @Nullable default DestinationS3BackupProps getS3Backup()
      (experimental) The configuration for backing up source records to S3.

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

    • builder

      @Stability(Experimental) static CommonDestinationProps.Builder builder()
      Returns:
      a CommonDestinationProps.Builder of CommonDestinationProps