Interface IDestinationConfig

A Kinesis Data Firehose delivery stream destination configuration.

Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDestinationConfig
Syntax (vb)
Public Interface IDestinationConfig
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisFirehose;
using Constructs;

IDependable dependable;
var destinationConfig = new DestinationConfig {
    Dependables = new [] { dependable },
    ExtendedS3DestinationConfiguration = new ExtendedS3DestinationConfigurationProperty {
        BucketArn = "bucketArn",
        RoleArn = "roleArn",

        // the properties below are optional
        BufferingHints = new BufferingHintsProperty {
            IntervalInSeconds = 123,
            SizeInMBs = 123
        },
        CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
            Enabled = false,
            LogGroupName = "logGroupName",
            LogStreamName = "logStreamName"
        },
        CompressionFormat = "compressionFormat",
        CustomTimeZone = "customTimeZone",
        DataFormatConversionConfiguration = new DataFormatConversionConfigurationProperty {
            Enabled = false,
            InputFormatConfiguration = new InputFormatConfigurationProperty {
                Deserializer = new DeserializerProperty {
                    HiveJsonSerDe = new HiveJsonSerDeProperty {
                        TimestampFormats = new [] { "timestampFormats" }
                    },
                    OpenXJsonSerDe = new OpenXJsonSerDeProperty {
                        CaseInsensitive = false,
                        ColumnToJsonKeyMappings = new Dictionary<string, string> {
                            { "columnToJsonKeyMappingsKey", "columnToJsonKeyMappings" }
                        },
                        ConvertDotsInJsonKeysToUnderscores = false
                    }
                }
            },
            OutputFormatConfiguration = new OutputFormatConfigurationProperty {
                Serializer = new SerializerProperty {
                    OrcSerDe = new OrcSerDeProperty {
                        BlockSizeBytes = 123,
                        BloomFilterColumns = new [] { "bloomFilterColumns" },
                        BloomFilterFalsePositiveProbability = 123,
                        Compression = "compression",
                        DictionaryKeyThreshold = 123,
                        EnablePadding = false,
                        FormatVersion = "formatVersion",
                        PaddingTolerance = 123,
                        RowIndexStride = 123,
                        StripeSizeBytes = 123
                    },
                    ParquetSerDe = new ParquetSerDeProperty {
                        BlockSizeBytes = 123,
                        Compression = "compression",
                        EnableDictionaryCompression = false,
                        MaxPaddingBytes = 123,
                        PageSizeBytes = 123,
                        WriterVersion = "writerVersion"
                    }
                }
            },
            SchemaConfiguration = new SchemaConfigurationProperty {
                CatalogId = "catalogId",
                DatabaseName = "databaseName",
                Region = "region",
                RoleArn = "roleArn",
                TableName = "tableName",
                VersionId = "versionId"
            }
        },
        DynamicPartitioningConfiguration = new DynamicPartitioningConfigurationProperty {
            Enabled = false,
            RetryOptions = new RetryOptionsProperty {
                DurationInSeconds = 123
            }
        },
        EncryptionConfiguration = new EncryptionConfigurationProperty {
            KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                AwskmsKeyArn = "awskmsKeyArn"
            },
            NoEncryptionConfig = "noEncryptionConfig"
        },
        ErrorOutputPrefix = "errorOutputPrefix",
        FileExtension = "fileExtension",
        Prefix = "prefix",
        ProcessingConfiguration = new ProcessingConfigurationProperty {
            Enabled = false,
            Processors = new [] { new ProcessorProperty {
                Type = "type",

                // the properties below are optional
                Parameters = new [] { new ProcessorParameterProperty {
                    ParameterName = "parameterName",
                    ParameterValue = "parameterValue"
                } }
            } }
        },
        S3BackupConfiguration = new S3DestinationConfigurationProperty {
            BucketArn = "bucketArn",
            RoleArn = "roleArn",

            // the properties below are optional
            BufferingHints = new BufferingHintsProperty {
                IntervalInSeconds = 123,
                SizeInMBs = 123
            },
            CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                Enabled = false,
                LogGroupName = "logGroupName",
                LogStreamName = "logStreamName"
            },
            CompressionFormat = "compressionFormat",
            EncryptionConfiguration = new EncryptionConfigurationProperty {
                KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                    AwskmsKeyArn = "awskmsKeyArn"
                },
                NoEncryptionConfig = "noEncryptionConfig"
            },
            ErrorOutputPrefix = "errorOutputPrefix",
            Prefix = "prefix"
        },
        S3BackupMode = "s3BackupMode"
    }
};

Synopsis

Properties

Dependables

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

S3 destination configuration properties.

Properties

Dependables

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

virtual IDependable[] Dependables { get; }
Property Value

Constructs.IDependable[]

Remarks

Default: []

ExtendedS3DestinationConfiguration

S3 destination configuration properties.

virtual CfnDeliveryStream.IExtendedS3DestinationConfigurationProperty ExtendedS3DestinationConfiguration { get; }
Property Value

CfnDeliveryStream.IExtendedS3DestinationConfigurationProperty

Remarks

Default: - S3 destination is not used.