AWS CDK Reference

Appearance

v2.275.0

PipeLogConfigurationProperty Struct ​

Represents the configuration settings for the logs to which this pipe should report events.

Source
Generated code
Type last changed
v2.110.0 · 17 Nov 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const pipeLogConfigurationProperty: pipes.CfnPipe.PipeLogConfigurationProperty = {
  cloudwatchLogsLogDestination: {
    logGroupArn: 'logGroupArn',
  },
  firehoseLogDestination: {
    deliveryStreamArn: 'deliveryStreamArn',
  },
  includeExecutionData: ['includeExecutionData'],
  level: 'level',
  s3LogDestination: {
    bucketName: 'bucketName',
    bucketOwner: 'bucketOwner',
    outputFormat: 'outputFormat',
    prefix: 'prefix',
  },
};

Properties ​

cloudwatchLogsLogDestinationoptionalIResolvable | CfnPipe.CloudwatchLogsLogDestinationPropertycloudwatch_logs_log_destinationoptionaltyping.Union[IResolvable, CloudwatchLogsLogDestinationProperty]cloudwatchLogsLogDestinationoptionalIResolvableCloudwatchLogsLogDestinationoptionalIResolvableCloudwatchLogsLogDestinationoptionalinterface{}#
The logging configuration settings for the pipe.
firehoseLogDestinationoptionalIResolvable | CfnPipe.FirehoseLogDestinationPropertyfirehose_log_destinationoptionaltyping.Union[IResolvable, FirehoseLogDestinationProperty]firehoseLogDestinationoptionalIResolvableFirehoseLogDestinationoptionalIResolvableFirehoseLogDestinationoptionalinterface{}#
The Amazon Data Firehose logging configuration settings for the pipe.
includeExecutionDataoptionalstring[]include_execution_dataoptionaltyping.List[str]includeExecutionDataoptionalList<String>IncludeExecutionDataoptionalstring[]IncludeExecutionDataoptional*[]*string#
Whether the execution data (specifically, the `payload` , `awsRequest` , and `awsResponse` fields) is included in the log messages for this pipe.
notes

This applies to all log destinations for the pipe.

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

Allowed values: ALL

leveloptionalstringleveloptionalstrleveloptionalStringLeveloptionalstringLeveloptional*string#
The level of logging detail to include.

This applies to all log destinations for the pipe.

s3LogDestinationoptionalIResolvable | CfnPipe.S3LogDestinationPropertys3_log_destinationoptionaltyping.Union[IResolvable, S3LogDestinationProperty]s3LogDestinationoptionalIResolvableS3LogDestinationoptionalIResolvableS3LogDestinationoptionalinterface{}#
The Amazon S3 logging configuration settings for the pipe.