CommonDestinationS3Props

class aws_cdk.aws_kinesisfirehose.CommonDestinationS3Props(*, buffering_interval=None, buffering_size=None, compression=None, data_output_prefix=None, encryption_key=None, error_output_prefix=None)

Bases: object

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

Parameters:

buffering_interval (Optional[Duration]) – The length of time that Firehose buffers incoming data before delivering it to the S3 bucket. Minimum: Duration.seconds(0) Maximum: Duration.seconds(900) Default: Duration.seconds(300)
buffering_size (Optional[Size]) – The size of the buffer that Amazon Data Firehose uses for incoming data before delivering it to the S3 bucket. Minimum: Size.mebibytes(1) Maximum: Size.mebibytes(128) Default: Size.mebibytes(5)
compression (Optional[Compression]) – The type of compression that Amazon 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. Default: - UNCOMPRESSED
data_output_prefix (Optional[str]) – A prefix that Amazon Data Firehose evaluates and adds to records before writing them to S3. This prefix appears immediately following the bucket name. Default: “YYYY/MM/DD/HH”
encryption_key (Optional[IKey]) – The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket. Default: - Data is not encrypted.
error_output_prefix (Optional[str]) – A prefix that Amazon Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. Default: “YYYY/MM/DD/HH”

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_kinesisfirehose as kinesisfirehose
from aws_cdk import aws_kms as kms

# compression: kinesisfirehose.Compression
# key: kms.Key
# size: cdk.Size

common_destination_s3_props = kinesisfirehose.CommonDestinationS3Props(
    buffering_interval=cdk.Duration.minutes(30),
    buffering_size=size,
    compression=compression,
    data_output_prefix="dataOutputPrefix",
    encryption_key=key,
    error_output_prefix="errorOutputPrefix"
)

Attributes

buffering_interval

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

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

Default:: Duration.seconds(300)

buffering_size

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

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

Default:: Size.mebibytes(5)

compression

The type of compression that Amazon 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.

Default:

UNCOMPRESSED

data_output_prefix

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

This prefix appears immediately following the bucket name.

Default:: “YYYY/MM/DD/HH”
See:: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html

encryption_key

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

Default:

Data is not encrypted.

error_output_prefix

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

This prefix appears immediately following the bucket name.

Default:: “YYYY/MM/DD/HH”
See:: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html