Package software.amazon.awscdk.services.kinesisfirehose.alpha

Interface DestinationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DestinationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:41.553Z")
@Stability(Experimental)
public interface DestinationConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) A Kinesis Data Firehose delivery stream destination configuration.

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.constructs.*;
 IDependable dependable;
 DestinationConfig destinationConfig = DestinationConfig.builder()
         .dependables(List.of(dependable))
         .extendedS3DestinationConfiguration(ExtendedS3DestinationConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .bufferingHints(BufferingHintsProperty.builder()
                         .intervalInSeconds(123)
                         .sizeInMBs(123)
                         .build())
                 .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                         .enabled(false)
                         .logGroupName("logGroupName")
                         .logStreamName("logStreamName")
                         .build())
                 .compressionFormat("compressionFormat")
                 .customTimeZone("customTimeZone")
                 .dataFormatConversionConfiguration(DataFormatConversionConfigurationProperty.builder()
                         .enabled(false)
                         .inputFormatConfiguration(InputFormatConfigurationProperty.builder()
                                 .deserializer(DeserializerProperty.builder()
                                         .hiveJsonSerDe(HiveJsonSerDeProperty.builder()
                                                 .timestampFormats(List.of("timestampFormats"))
                                                 .build())
                                         .openXJsonSerDe(OpenXJsonSerDeProperty.builder()
                                                 .caseInsensitive(false)
                                                 .columnToJsonKeyMappings(Map.of(
                                                         "columnToJsonKeyMappingsKey", "columnToJsonKeyMappings"))
                                                 .convertDotsInJsonKeysToUnderscores(false)
                                                 .build())
                                         .build())
                                 .build())
                         .outputFormatConfiguration(OutputFormatConfigurationProperty.builder()
                                 .serializer(SerializerProperty.builder()
                                         .orcSerDe(OrcSerDeProperty.builder()
                                                 .blockSizeBytes(123)
                                                 .bloomFilterColumns(List.of("bloomFilterColumns"))
                                                 .bloomFilterFalsePositiveProbability(123)
                                                 .compression("compression")
                                                 .dictionaryKeyThreshold(123)
                                                 .enablePadding(false)
                                                 .formatVersion("formatVersion")
                                                 .paddingTolerance(123)
                                                 .rowIndexStride(123)
                                                 .stripeSizeBytes(123)
                                                 .build())
                                         .parquetSerDe(ParquetSerDeProperty.builder()
                                                 .blockSizeBytes(123)
                                                 .compression("compression")
                                                 .enableDictionaryCompression(false)
                                                 .maxPaddingBytes(123)
                                                 .pageSizeBytes(123)
                                                 .writerVersion("writerVersion")
                                                 .build())
                                         .build())
                                 .build())
                         .schemaConfiguration(SchemaConfigurationProperty.builder()
                                 .catalogId("catalogId")
                                 .databaseName("databaseName")
                                 .region("region")
                                 .roleArn("roleArn")
                                 .tableName("tableName")
                                 .versionId("versionId")
                                 .build())
                         .build())
                 .dynamicPartitioningConfiguration(DynamicPartitioningConfigurationProperty.builder()
                         .enabled(false)
                         .retryOptions(RetryOptionsProperty.builder()
                                 .durationInSeconds(123)
                                 .build())
                         .build())
                 .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                         .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder()
                                 .awskmsKeyArn("awskmsKeyArn")
                                 .build())
                         .noEncryptionConfig("noEncryptionConfig")
                         .build())
                 .errorOutputPrefix("errorOutputPrefix")
                 .fileExtension("fileExtension")
                 .prefix("prefix")
                 .processingConfiguration(ProcessingConfigurationProperty.builder()
                         .enabled(false)
                         .processors(List.of(ProcessorProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .parameters(List.of(ProcessorParameterProperty.builder()
                                         .parameterName("parameterName")
                                         .parameterValue("parameterValue")
                                         .build()))
                                 .build()))
                         .build())
                 .s3BackupConfiguration(S3DestinationConfigurationProperty.builder()
                         .bucketArn("bucketArn")
                         .roleArn("roleArn")
                         // the properties below are optional
                         .bufferingHints(BufferingHintsProperty.builder()
                                 .intervalInSeconds(123)
                                 .sizeInMBs(123)
                                 .build())
                         .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                                 .enabled(false)
                                 .logGroupName("logGroupName")
                                 .logStreamName("logStreamName")
                                 .build())
                         .compressionFormat("compressionFormat")
                         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                                 .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder()
                                         .awskmsKeyArn("awskmsKeyArn")
                                         .build())
                                 .noEncryptionConfig("noEncryptionConfig")
                                 .build())
                         .errorOutputPrefix("errorOutputPrefix")
                         .prefix("prefix")
                         .build())
                 .s3BackupMode("s3BackupMode")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DestinationConfig.Builder	builder()
default List<software.constructs.IDependable>	getDependables()	(experimental) Any resources that were created by the destination when binding it to the stack that must be deployed before the delivery stream is deployed.
default CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty	getExtendedS3DestinationConfiguration()	(experimental) S3 destination configuration properties.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDependables

@Stability(Experimental)
@Nullable
default List<software.constructs.IDependable> getDependables()

(experimental) Any resources that were created by the destination when binding it to the stack that must be deployed before the delivery stream is deployed.

Default: []

getExtendedS3DestinationConfiguration

@Stability(Experimental)
@Nullable
default CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty getExtendedS3DestinationConfiguration()

(experimental) S3 destination configuration properties.

Default: - S3 destination is not used.

builder

@Stability(Experimental)
static DestinationConfig.Builder builder()

Returns:

a DestinationConfig.Builder of DestinationConfig