Class: Aws::Pipes::Types::PipeLogConfigurationParameters
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pipes::Types::PipeLogConfigurationParameters
- Defined in:
- gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb
Overview
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 Amazon Web Services 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 Kinesis
Data 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 Kinesis Data Firehose stream log
destination.
For more information on generating pipe log records, see Log EventBridge Pipes in the Amazon EventBridge User Guide.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#cloudwatch_logs_log_destination ⇒ Types::CloudwatchLogsLogDestinationParameters
The Amazon CloudWatch Logs logging configuration settings for the pipe.
-
#firehose_log_destination ⇒ Types::FirehoseLogDestinationParameters
The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
-
#include_execution_data ⇒ Array<String>
Specify
ON
to include the execution data (specifically, thepayload
andawsRequest
fields) in the log messages for this pipe. -
#level ⇒ String
The level of logging detail to include.
-
#s3_log_destination ⇒ Types::S3LogDestinationParameters
The Amazon S3 logging configuration settings for the pipe.
Instance Attribute Details
#cloudwatch_logs_log_destination ⇒ Types::CloudwatchLogsLogDestinationParameters
The Amazon CloudWatch Logs logging configuration settings for the pipe.
1577 1578 1579 1580 1581 1582 1583 1584 1585 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1577 class PipeLogConfigurationParameters < Struct.new( :cloudwatch_logs_log_destination, :firehose_log_destination, :include_execution_data, :level, :s3_log_destination) SENSITIVE = [] include Aws::Structure end |
#firehose_log_destination ⇒ Types::FirehoseLogDestinationParameters
The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
1577 1578 1579 1580 1581 1582 1583 1584 1585 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1577 class PipeLogConfigurationParameters < Struct.new( :cloudwatch_logs_log_destination, :firehose_log_destination, :include_execution_data, :level, :s3_log_destination) SENSITIVE = [] include Aws::Structure end |
#include_execution_data ⇒ Array<String>
Specify ON
to include the execution data (specifically, the
payload
and awsRequest
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.
The default is OFF
.
1577 1578 1579 1580 1581 1582 1583 1584 1585 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1577 class PipeLogConfigurationParameters < Struct.new( :cloudwatch_logs_log_destination, :firehose_log_destination, :include_execution_data, :level, :s3_log_destination) SENSITIVE = [] include Aws::Structure end |
#level ⇒ String
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.
1577 1578 1579 1580 1581 1582 1583 1584 1585 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1577 class PipeLogConfigurationParameters < Struct.new( :cloudwatch_logs_log_destination, :firehose_log_destination, :include_execution_data, :level, :s3_log_destination) SENSITIVE = [] include Aws::Structure end |
#s3_log_destination ⇒ Types::S3LogDestinationParameters
The Amazon S3 logging configuration settings for the pipe.
1577 1578 1579 1580 1581 1582 1583 1584 1585 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1577 class PipeLogConfigurationParameters < Struct.new( :cloudwatch_logs_log_destination, :firehose_log_destination, :include_execution_data, :level, :s3_log_destination) SENSITIVE = [] include Aws::Structure end |