Skip to content

S3Storage

Source code in docs_src/capo_kafka/types/s3_storage.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class S3Storage(TypedDict, closed=True):
    bucket_arn: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.</p>"""
    compression_type: NotRequired[
        "capo_kafka.types.s3_compression_type.S3CompressionType"
    ]
    """<p>The compression codec applied to delivered Amazon S3 objects.</p>"""
    output_prefix: NotRequired["capo_kafka.types.__string.__string"]
    """<p>An optional prefix prepended to every Amazon S3 object key written by the channel.</p>"""
    output_key_template: NotRequired["capo_kafka.types.__string.__string"]
    """<p>An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.</p>"""
    storage_class: NotRequired["capo_kafka.types.s3_storage_class.S3StorageClass"]
    """<p>The Amazon S3 storage class for delivered objects.</p>"""
    expected_bucket_owner: NotRequired["capo_kafka.types.__string.__string"]
    """<p>Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.</p>"""

bucket_arn instance-attribute 

bucket_arn: NotRequired[__string]

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

compression_type instance-attribute 

compression_type: NotRequired[S3CompressionType]

The compression codec applied to delivered Amazon S3 objects.

expected_bucket_owner instance-attribute 

expected_bucket_owner: NotRequired[__string]

Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.

output_key_template instance-attribute 

output_key_template: NotRequired[__string]

An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.

output_prefix instance-attribute 

output_prefix: NotRequired[__string]

An optional prefix prepended to every Amazon S3 object key written by the channel.

storage_class instance-attribute 

storage_class: NotRequired[S3StorageClass]

The Amazon S3 storage class for delivered objects.