Skip to content

S3LogDestinationParameters

Source code in docs_src/capo_pipes/types/s3_log_destination_parameters.py 
14
15
16
17
18
19
20
21
22
class S3LogDestinationParameters(TypedDict, closed=True):
    bucket_name: "capo_pipes.types.string.String"
    """<p>Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</p>"""
    bucket_owner: "capo_pipes.types.string.String"
    """<p>Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</p>"""
    output_format: NotRequired["capo_pipes.types.s3_output_format.S3OutputFormat"]
    """<p>How EventBridge should format the log records.</p> <p>EventBridge currently only supports <code>json</code> formatting.</p>"""
    prefix: NotRequired["capo_pipes.types.string.String"]
    """<p>Specifies any prefix text with which to begin Amazon S3 log object names.</p> <p>You can use prefixes to organize the data that you store in Amazon S3 buckets. A prefix is a string of characters at the beginning of the object key name. A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"""

bucket_name instance-attribute 

bucket_name: String

Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

bucket_owner instance-attribute 

bucket_owner: String

Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

output_format instance-attribute 

output_format: NotRequired[S3OutputFormat]

How EventBridge should format the log records.

EventBridge currently only supports json formatting.

prefix instance-attribute 

prefix: NotRequired[String]

Specifies any prefix text with which to begin Amazon S3 log object names.

You can use prefixes to organize the data that you store in Amazon S3 buckets. A prefix is a string of characters at the beginning of the object key name. A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.