PipeLogConfigurationParameters - Amazon EventBridge Pipes
ContentsSee Also

PipeLogConfigurationParameters

Specifies the logging configuration settings for the pipe.

When you call UpdatePipe, EventBridge updates the fields in the PipeLogConfigurationParameters object atomically as one and overrides existing values. This is by design. If you don't specify an optional field in any of the AWS service parameters objects (CloudwatchLogsLogDestinationParameters, FirehoseLogDestinationParameters, or S3LogDestinationParameters), EventBridge sets that field to its system-default value during the update.

For example, suppose when you created the pipe you specified a Firehose stream log destination. You then update the pipe to add an Amazon S3 log destination. In addition to specifying the S3LogDestinationParameters for the new log destination, you must also specify the fields in the FirehoseLogDestinationParameters object in order to retain the Firehose stream log destination.

For more information on generating pipe log records, see Log EventBridge Pipes in the Amazon EventBridge User Guide.

Contents

Level

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

For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.

Type: String

Valid Values: OFF | ERROR | INFO | TRACE

Required: Yes

CloudwatchLogsLogDestination

The Amazon CloudWatch Logs logging configuration settings for the pipe.

Type: CloudwatchLogsLogDestinationParameters object

Required: No

FirehoseLogDestination

The Amazon Data Firehose logging configuration settings for the pipe.

Type: FirehoseLogDestinationParameters object

Required: No

IncludeExecutionData

Specify ALL to include the execution data (specifically, the payload, awsRequest, and awsResponse fields) 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.

By default, execution data is not included.

Type: Array of strings

Valid Values: ALL

Required: No

S3LogDestination

The Amazon S3 logging configuration settings for the pipe.

Type: S3LogDestinationParameters object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: