@aws-cdk_aws-kinesisfirehose-destinations-alpha.CommonDestinationS3Props

interface CommonDestinationS3Props ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.KinesisFirehose.Destinations.Alpha.CommonDestinationS3Props
Gogithub.com/aws/aws-cdk-go/awscdkkinesisfirehosedestinationsalpha/v2#CommonDestinationS3Props
Javasoftware.amazon.awscdk.services.kinesisfirehose.destinations.alpha.CommonDestinationS3Props
Pythonaws_cdk.aws_kinesisfirehose_destinations_alpha.CommonDestinationS3Props
TypeScript (source)@aws-cdk/aws-kinesisfirehose-destinations-alpha ยป CommonDestinationS3Props

Common properties for defining a backup, intermediary, or final S3 destination for a Kinesis Data Firehose delivery stream.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kinesisfirehose_destinations_alpha from '@aws-cdk/aws-kinesisfirehose-destinations-alpha';
import * as cdk from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';

declare const compression: kinesisfirehose_destinations_alpha.Compression;
declare const key: kms.Key;
declare const size: cdk.Size;
const commonDestinationS3Props: kinesisfirehose_destinations_alpha.CommonDestinationS3Props = {
  bufferingInterval: cdk.Duration.minutes(30),
  bufferingSize: size,
  compression: compression,
  dataOutputPrefix: 'dataOutputPrefix',
  encryptionKey: key,
  errorOutputPrefix: 'errorOutputPrefix',
};

Properties

NameTypeDescription
bufferingInterval?๐Ÿ”นDurationThe length of time that Firehose buffers incoming data before delivering it to the S3 bucket.
bufferingSize?๐Ÿ”นSizeThe size of the buffer that Kinesis Data Firehose uses for incoming data before delivering it to the S3 bucket.
compression?๐Ÿ”นCompressionThe type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
dataOutputPrefix?๐Ÿ”นstringA prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3.
encryptionKey?๐Ÿ”นIKeyThe AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.
errorOutputPrefix?๐Ÿ”นstringA prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.

bufferingInterval?๐Ÿ”น

Type: Duration (optional, default: Duration.seconds(300))

The length of time that Firehose buffers incoming data before delivering it to the S3 bucket.

Minimum: Duration.seconds(60) Maximum: Duration.seconds(900)


bufferingSize?๐Ÿ”น

Type: Size (optional, default: Size.mebibytes(5))

The size of the buffer that Kinesis Data Firehose uses for incoming data before delivering it to the S3 bucket.

Minimum: Size.mebibytes(1) Maximum: Size.mebibytes(128)


compression?๐Ÿ”น

Type: Compression (optional, default: UNCOMPRESSED)

The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.

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.


dataOutputPrefix?๐Ÿ”น

Type: string (optional, default: "YYYY/MM/DD/HH")

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

This prefix appears immediately following the bucket name.

See also: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html


encryptionKey?๐Ÿ”น

Type: IKey (optional, default: Data is not encrypted.)

The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.


errorOutputPrefix?๐Ÿ”น

Type: string (optional, default: "YYYY/MM/DD/HH")

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

This prefix appears immediately following the bucket name.

See also: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html