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.104.0 (build e79254c)",
date="2024-11-22T02:24:11.905Z")
@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.kinesisfirehose.alpha.*; import software.amazon.awscdk.services.kinesisfirehose.destinations.alpha.*; import software.amazon.awscdk.*; import software.amazon.awscdk.services.iam.*; 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) .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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCommonDestinationProps
static final class
An implementation forCommonDestinationProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default ILoggingConfig
(experimental) 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
(experimental) The data transformation that should be performed on the data before writing to the destination.default IRole
getRole()
(experimental) The IAM role associated with this destination.default DestinationS3BackupProps
(experimental) The configuration for backing up source records to S3.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getLoggingConfig
(experimental) 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
(experimental) The data transformation that should be performed on the data before writing to the destination.Default: - no data transformation will occur.
-
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
(experimental) The configuration for backing up source records to S3.Default: - source records will not be backed up to S3.
-
builder
- Returns:
- a
CommonDestinationProps.Builder
ofCommonDestinationProps
-