Skip to content

ExtendedS3DestinationConfiguration

Source code in docs_src/capo_firehose/types/extended_s3_destination_configuration.py
class ExtendedS3DestinationConfiguration(TypedDict, closed=True):
    role_arn: "capo_firehose.types.role_arn.RoleARN"
    """<p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>"""
    bucket_arn: "capo_firehose.types.bucket_arn.BucketARN"
    """<p>The ARN of the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>"""
    prefix: NotRequired["capo_firehose.types.prefix.Prefix"]
    """<p>The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3 Objects</a>.</p>"""
    error_output_prefix: NotRequired[
        "capo_firehose.types.error_output_prefix.ErrorOutputPrefix"
    ]
    """<p>A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see <a href="https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html">Custom Prefixes for Amazon S3 Objects</a>.</p>"""
    buffering_hints: NotRequired["capo_firehose.types.buffering_hints.BufferingHints"]
    """<p>The buffering option.</p>"""
    compression_format: NotRequired[
        "capo_firehose.types.compression_format.CompressionFormat"
    ]
    """<p>The compression format. If no value is specified, the default is UNCOMPRESSED.</p>"""
    encryption_configuration: NotRequired[
        "capo_firehose.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>The encryption configuration. If no value is specified, the default is no encryption.</p>"""
    cloud_watch_logging_options: NotRequired[
        "capo_firehose.types.cloud_watch_logging_options.CloudWatchLoggingOptions"
    ]
    """<p>The Amazon CloudWatch logging options for your Firehose stream.</p>"""
    processing_configuration: NotRequired[
        "capo_firehose.types.processing_configuration.ProcessingConfiguration"
    ]
    """<p>The data processing configuration.</p>"""
    s3_backup_mode: NotRequired["capo_firehose.types.s3_backup_mode.S3BackupMode"]
    """<p>The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it. </p>"""
    s3_backup_configuration: NotRequired[
        "capo_firehose.types.s3_destination_configuration.S3DestinationConfiguration"
    ]
    """<p>The configuration for backup in Amazon S3.</p>"""
    data_format_conversion_configuration: NotRequired[
        "capo_firehose.types.data_format_conversion_configuration.DataFormatConversionConfiguration"
    ]
    """<p>The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.</p>"""
    dynamic_partitioning_configuration: NotRequired[
        "capo_firehose.types.dynamic_partitioning_configuration.DynamicPartitioningConfiguration"
    ]
    """<p>The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. </p>"""
    file_extension: NotRequired["capo_firehose.types.file_extension.FileExtension"]
    """<p>Specify a file extension. It will override the default file extension</p>"""
    custom_time_zone: NotRequired["capo_firehose.types.custom_time_zone.CustomTimeZone"]
    """<p>The time zone you prefer. UTC is the default.</p>"""

bucket_arn instance-attribute

bucket_arn: BucketARN

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

buffering_hints instance-attribute

buffering_hints: NotRequired[BufferingHints]

The buffering option.

cloud_watch_logging_options instance-attribute

cloud_watch_logging_options: NotRequired[CloudWatchLoggingOptions]

The Amazon CloudWatch logging options for your Firehose stream.

compression_format instance-attribute

compression_format: NotRequired[CompressionFormat]

The compression format. If no value is specified, the default is UNCOMPRESSED.

custom_time_zone instance-attribute

custom_time_zone: NotRequired[CustomTimeZone]

The time zone you prefer. UTC is the default.

data_format_conversion_configuration instance-attribute

data_format_conversion_configuration: NotRequired[DataFormatConversionConfiguration]

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

dynamic_partitioning_configuration instance-attribute

dynamic_partitioning_configuration: NotRequired[DynamicPartitioningConfiguration]

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

The encryption configuration. If no value is specified, the default is no encryption.

error_output_prefix instance-attribute

error_output_prefix: NotRequired[ErrorOutputPrefix]

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

file_extension instance-attribute

file_extension: NotRequired[FileExtension]

Specify a file extension. It will override the default file extension

prefix instance-attribute

prefix: NotRequired[Prefix]

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

processing_configuration instance-attribute

processing_configuration: NotRequired[ProcessingConfiguration]

The data processing configuration.

role_arn instance-attribute

role_arn: RoleARN

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

s3_backup_configuration instance-attribute

s3_backup_configuration: NotRequired[S3DestinationConfiguration]

The configuration for backup in Amazon S3.

s3_backup_mode instance-attribute

s3_backup_mode: NotRequired[S3BackupMode]

The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.