Skip to content

S3DestinationUpdate

Source code in docs_src/capo_firehose/types/s3_destination_update.py
class S3DestinationUpdate(TypedDict, closed=True):
    role_arn: NotRequired["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: NotRequired["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. If no value is specified, <code>BufferingHints</code> object default values are used.</p>"""
    compression_format: NotRequired[
        "capo_firehose.types.compression_format.CompressionFormat"
    ]
    """<p>The compression format. If no value is specified, the default is <code>UNCOMPRESSED</code>.</p> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket.</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 CloudWatch logging options for your Firehose stream.</p>"""

bucket_arn instance-attribute

bucket_arn: NotRequired[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. If no value is specified, BufferingHints object default values are used.

cloud_watch_logging_options instance-attribute

cloud_watch_logging_options: NotRequired[CloudWatchLoggingOptions]

The 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.

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.

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.

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.

role_arn instance-attribute

role_arn: NotRequired[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.