Skip to content

PipeLogConfiguration

Source code in docs_src/capo_pipes/types/pipe_log_configuration.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class PipeLogConfiguration(TypedDict, closed=True):
    s3_log_destination: NotRequired[
        "capo_pipes.types.s3_log_destination.S3LogDestination"
    ]
    """<p>The Amazon S3 logging configuration settings for the pipe.</p>"""
    firehose_log_destination: NotRequired[
        "capo_pipes.types.firehose_log_destination.FirehoseLogDestination"
    ]
    """<p>The Amazon Data Firehose logging configuration settings for the pipe.</p>"""
    cloudwatch_logs_log_destination: NotRequired[
        "capo_pipes.types.cloudwatch_logs_log_destination.CloudwatchLogsLogDestination"
    ]
    """<p>The Amazon CloudWatch Logs logging configuration settings for the pipe.</p>"""
    level: NotRequired["capo_pipes.types.log_level.LogLevel"]
    """<p>The level of logging detail to include. This applies to all log destinations for the pipe.</p>"""
    include_execution_data: NotRequired[
        "capo_pipes.types.include_execution_data.IncludeExecutionData"
    ]
    """<p>Whether the execution data (specifically, the <code>payload</code>, <code>awsRequest</code>, and <code>awsResponse</code> fields) is included in the log messages for this pipe.</p> <p>This applies to all log destinations for the pipe.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data">Including execution data in logs</a> in the <i>Amazon EventBridge User Guide</i>.</p>"""

cloudwatch_logs_log_destination instance-attribute 

cloudwatch_logs_log_destination: NotRequired[CloudwatchLogsLogDestination]

The Amazon CloudWatch Logs logging configuration settings for the pipe.

firehose_log_destination instance-attribute 

firehose_log_destination: NotRequired[FirehoseLogDestination]

The Amazon Data Firehose logging configuration settings for the pipe.

include_execution_data instance-attribute 

include_execution_data: NotRequired[IncludeExecutionData]

Whether the execution data (specifically, the payload, awsRequest, and awsResponse fields) is included in the log messages for this pipe.

This applies to all log destinations for the pipe.

For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

level instance-attribute 

level: NotRequired[LogLevel]

The level of logging detail to include. This applies to all log destinations for the pipe.

s3_log_destination instance-attribute 

s3_log_destination: NotRequired[S3LogDestination]

The Amazon S3 logging configuration settings for the pipe.