Class CommonDestinationS3Props
(experimental) Common properties for defining a backup, intermediary, or final S3 destination for a Kinesis Data Firehose delivery stream.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.KinesisFirehose.Destinations
Assembly: Amazon.CDK.AWS.KinesisFirehose.Destinations.dll
Syntax (csharp)
public class CommonDestinationS3Props : Object, ICommonDestinationS3Props
Syntax (vb)
Public Class CommonDestinationS3Props
Inherits Object
Implements ICommonDestinationS3Props
Remarks
Stability: Experimental
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.Destinations;
using Amazon.CDK.AWS.KMS;
using Amazon.CDK;
Compression compression;
Key key;
Size size;
var commonDestinationS3Props = new CommonDestinationS3Props {
BufferingInterval = Duration.Minutes(30),
BufferingSize = size,
Compression = compression,
DataOutputPrefix = "dataOutputPrefix",
EncryptionKey = key,
ErrorOutputPrefix = "errorOutputPrefix"
};
Synopsis
Constructors
CommonDestinationS3Props() |
Properties
BufferingInterval | (experimental) The length of time that Firehose buffers incoming data before delivering it to the S3 bucket. |
BufferingSize | (experimental) The size of the buffer that Kinesis Data Firehose uses for incoming data before delivering it to the S3 bucket. |
Compression | (experimental) The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. |
DataOutputPrefix | (experimental) A prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3. |
EncryptionKey | (experimental) The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket. |
ErrorOutputPrefix | (experimental) A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. |
Constructors
CommonDestinationS3Props()
public CommonDestinationS3Props()
Properties
BufferingInterval
(experimental) The length of time that Firehose buffers incoming data before delivering it to the S3 bucket.
public Duration BufferingInterval { get; set; }
Property Value
Remarks
Minimum: Duration.seconds(60) Maximum: Duration.seconds(900)
Default: Duration.seconds(300)
Stability: Experimental
BufferingSize
(experimental) The size of the buffer that Kinesis Data Firehose uses for incoming data before delivering it to the S3 bucket.
public Size BufferingSize { get; set; }
Property Value
Remarks
Minimum: Size.mebibytes(1) Maximum: Size.mebibytes(128)
Default: Size.mebibytes(5)
Stability: Experimental
Compression
(experimental) The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
public Compression Compression { get; set; }
Property Value
Remarks
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
Default: - UNCOMPRESSED
Stability: Experimental
DataOutputPrefix
(experimental) A prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3.
public string DataOutputPrefix { get; set; }
Property Value
System.String
Remarks
This prefix appears immediately following the bucket name.
Default: "YYYY/MM/DD/HH"
Stability: Experimental
See: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html
EncryptionKey
(experimental) The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.
public IKey EncryptionKey { get; set; }
Property Value
Remarks
Default: - Data is not encrypted.
Stability: Experimental
ErrorOutputPrefix
(experimental) A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
public string ErrorOutputPrefix { get; set; }
Property Value
System.String
Remarks
This prefix appears immediately following the bucket name.
Default: "YYYY/MM/DD/HH"
Stability: Experimental
See: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html