Interface CfnDeliveryStream.IExtendedS3DestinationConfigurationProperty

The ExtendedS3DestinationConfiguration property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream.

Namespace: Amazon.CDK.AWS.KinesisFirehose

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnDeliveryStream.IExtendedS3DestinationConfigurationProperty

Syntax (vb)

Public Interface CfnDeliveryStream.IExtendedS3DestinationConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html

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;

             var extendedS3DestinationConfigurationProperty = 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

BucketArn	The Amazon Resource Name (ARN) of the Amazon S3 bucket.
BufferingHints	The buffering option.
CloudWatchLoggingOptions	The Amazon CloudWatch logging options for your Firehose stream.
CompressionFormat	The compression format.
CustomTimeZone	The time zone you prefer.
DataFormatConversionConfiguration	The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
DynamicPartitioningConfiguration	The configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.
EncryptionConfiguration	The encryption configuration for the Kinesis Data Firehose delivery stream.
ErrorOutputPrefix	A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
FileExtension	Specify a file extension.
Prefix	The `YYYY/MM/DD/HH` time format prefix is automatically used for delivered Amazon S3 files.
ProcessingConfiguration	The data processing configuration for the Kinesis Data Firehose delivery stream.
RoleArn	The Amazon Resource Name (ARN) of the AWS credentials.
S3BackupConfiguration	The configuration for backup in Amazon S3.
S3BackupMode	The Amazon S3 backup mode.

Properties

BucketArn

The Amazon Resource Name (ARN) of the Amazon S3 bucket.

string BucketArn { get; }

Property Value

string

Remarks

For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bucketarn

BufferingHints

The buffering option.

object? BufferingHints { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStream.IBufferingHintsProperty

CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your Firehose stream.

object? CloudWatchLoggingOptions { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStream.ICloudWatchLoggingOptionsProperty

CompressionFormat

The compression format.

string? CompressionFormat { get; }

Property Value

string

Remarks

If no value is specified, the default is UNCOMPRESSED .

CustomTimeZone

The time zone you prefer.

string? CustomTimeZone { get; }

Property Value

string

Remarks

UTC is the default.

DataFormatConversionConfiguration

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

object? DataFormatConversionConfiguration { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStream.IDataFormatConversionConfigurationProperty

DynamicPartitioningConfiguration

The configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.

object? DynamicPartitioningConfiguration { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStream.IDynamicPartitioningConfigurationProperty

EncryptionConfiguration

The encryption configuration for the Kinesis Data Firehose delivery stream.

object? EncryptionConfiguration { get; }

Property Value

object

Remarks

The default value is NoEncryption .

Type union: either IResolvable or CfnDeliveryStream.IEncryptionConfigurationProperty

ErrorOutputPrefix

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.

string? ErrorOutputPrefix { get; }

Property Value

string

Remarks

This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects .

FileExtension

Specify a file extension.

string? FileExtension { get; }

Property Value

string

Remarks

It will override the default file extension

Prefix

The YYYY/MM/DD/HH time format prefix is automatically used for delivered Amazon S3 files.

string? Prefix { get; }

Property Value

string

Remarks

For more information, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

ProcessingConfiguration

The data processing configuration for the Kinesis Data Firehose delivery stream.

object? ProcessingConfiguration { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStream.IProcessingConfigurationProperty

RoleArn

The Amazon Resource Name (ARN) of the AWS credentials.

string RoleArn { get; }

Property Value

string

Remarks

For constraints, see ExtendedS3DestinationConfiguration in the Amazon Kinesis Data Firehose API Reference .

S3BackupConfiguration

The configuration for backup in Amazon S3.

object? S3BackupConfiguration { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStream.IS3DestinationConfigurationProperty

S3BackupMode

The Amazon S3 backup mode.

string? S3BackupMode { get; }

Property Value

string

Remarks

After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.