Skip to content

S3StorageConfiguration

Source code in docs_src/capo_kinesis/types/s3_storage_configuration.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class S3StorageConfiguration(TypedDict, closed=True):
    bucket_arn: "capo_kinesis.types.bucket_arn.BucketARN"
    """<p>The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.</p>"""
    expected_bucket_owner: (
        "capo_kinesis.types.expected_bucket_owner.ExpectedBucketOwner"
    )
    """<p>The Amazon Web Services account ID of the expected owner of the destination bucket. This value helps prevent delivery to an unintended bucket if ownership changes.</p>"""
    output_key_template: NotRequired[
        "capo_kinesis.types.s3_output_key_template.S3OutputKeyTemplate"
    ]
    """<p>The template used to construct the Amazon S3 object key for delivered objects. If not specified, a default template is used.</p>"""
    storage_class: NotRequired["capo_kinesis.types.s3_storage_class.S3StorageClass"]
    """<p>The Amazon S3 storage class for delivered objects. Valid values:</p> <ul> <li> <p> <code>STANDARD</code> - The default storage class, for frequently accessed data.</p> </li> <li> <p> <code>INTELLIGENT_TIERING</code> - Automatically moves objects to the most cost-effective access tier based on usage patterns.</p> </li> <li> <p> <code>GLACIER_IR</code> - Low-cost storage for rarely accessed data that requires millisecond retrieval.</p> </li> </ul>"""
    compression_type: "capo_kinesis.types.s3_compression_type.S3CompressionType"
    """<p>The compression applied to delivered objects. Valid values:</p> <ul> <li> <p> <code>NONE</code> - No compression.</p> </li> <li> <p> <code>GZIP</code> - gzip compression.</p> </li> <li> <p> <code>ZSTD</code> - Zstandard compression.</p> </li> </ul>"""

bucket_arn instance-attribute 

bucket_arn: BucketARN

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

compression_type instance-attribute 

compression_type: S3CompressionType

The compression applied to delivered objects. Valid values:

  • NONE - No compression.

  • GZIP - gzip compression.

  • ZSTD - Zstandard compression.

expected_bucket_owner instance-attribute 

expected_bucket_owner: ExpectedBucketOwner

The Amazon Web Services account ID of the expected owner of the destination bucket. This value helps prevent delivery to an unintended bucket if ownership changes.

output_key_template instance-attribute 

output_key_template: NotRequired[S3OutputKeyTemplate]

The template used to construct the Amazon S3 object key for delivered objects. If not specified, a default template is used.

storage_class instance-attribute 

storage_class: NotRequired[S3StorageClass]

The Amazon S3 storage class for delivered objects. Valid values:

  • STANDARD - The default storage class, for frequently accessed data.

  • INTELLIGENT_TIERING - Automatically moves objects to the most cost-effective access tier based on usage patterns.

  • GLACIER_IR - Low-cost storage for rarely accessed data that requires millisecond retrieval.