Skip to content

S3DestinationDescription

Source code in docs_src/capo_firehose/types/s3_destination_description.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class S3DestinationDescription(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: "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: "capo_firehose.types.compression_format.CompressionFormat"
    """<p>The compression format. If no value is specified, the default is <code>UNCOMPRESSED</code>.</p>"""
    encryption_configuration: (
        "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>"""

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: 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 Amazon CloudWatch logging options for your Firehose stream.

compression_format instance-attribute 

compression_format: CompressionFormat

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

encryption_configuration instance-attribute 

encryption_configuration: 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: 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.