AwsEventbridgePipeLogConfigurationArgs

interface AwsEventbridgePipeLogConfigurationArgs {
cloudwatchLogs?: AwsEventbridgePipeLogCloudwatchLogsArgs;
includeExecutionData?: boolean;
level: Input<'OFF' | 'ERROR' | 'INFO' | 'TRACE'>;
}

Logging configuration for AwsEventbridgePipe.

Remarks

When level is 'OFF', cloudwatchLogs may be omitted. When level is 'ERROR', 'INFO', or 'TRACE', cloudwatchLogs must be provided so that EventBridge has a destination for the log records. Set includeExecutionData to true to include the full event payload (payload, awsRequest, awsResponse) in log messages.

Example

CODE

// Disable logging explicitly (no CloudWatch destination needed)
const pipe = new AwsEventbridgePipe({
  name: 'myPipe',
  iamRole: pipeRole.arn,
  source: sourceQueue.arn,
  target: targetQueue.arn,
  logConfiguration: { level: 'OFF' },
});

CODE

// Enable INFO-level logging to CloudWatch Logs
const pipe = new AwsEventbridgePipe({
  name: 'myPipe',
  iamRole: pipeRole.arn,
  source: sourceQueue.arn,
  target: targetQueue.arn,
  logConfiguration: {
    level: 'INFO',
    includeExecutionData: true,
    cloudwatchLogs: { logGroupArn: logGroup.arn },
  },
});

Properties

`cloudwatchLogs: AwsEventbridgePipeLogCloudwatchLogsArgs`

CloudWatch Logs log destination.

Remarks

Required when level is 'ERROR', 'INFO', or 'TRACE'. May be omitted when level is 'OFF'. If provided alongside level: 'OFF', the destination is silently ignored — AWS does not accept a log destination when logging is disabled.

`includeExecutionData: boolean`

When true, the full execution data (payload, awsRequest, awsResponse) is included in each log message. Equivalent to setting includeExecutionDatas: ['ALL'] on the underlying provider resource. Defaults to false.

`level: Input<'OFF' | 'ERROR' | 'INFO' | 'TRACE'>`

Logging detail level. Valid values: OFF, ERROR, INFO, TRACE.