Struct aws_sdk_pipes::types::PipeLogConfigurationParameters

#[non_exhaustive]
pub struct PipeLogConfigurationParameters {
    pub s3_log_destination: Option<S3LogDestinationParameters>,
    pub firehose_log_destination: Option<FirehoseLogDestinationParameters>,
    pub cloudwatch_logs_log_destination: Option<CloudwatchLogsLogDestinationParameters>,
    pub level: LogLevel,
    pub include_execution_data: Option<Vec<IncludeExecutionDataOption>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

s3_log_destination: Option<S3LogDestinationParameters>

The Amazon S3 logging configuration settings for the pipe.

firehose_log_destination: Option<FirehoseLogDestinationParameters>

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

cloudwatch_logs_log_destination: Option<CloudwatchLogsLogDestinationParameters>

The Amazon CloudWatch Logs logging configuration settings for the pipe.

level: LogLevel

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.

include_execution_data: Option<Vec<IncludeExecutionDataOption>>

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.

Implementations

impl PipeLogConfigurationParameters

pub fn s3_log_destination(&self) -> Option<&S3LogDestinationParameters>

The Amazon S3 logging configuration settings for the pipe.

pub fn firehose_log_destination( &self ) -> Option<&FirehoseLogDestinationParameters>

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

pub fn cloudwatch_logs_log_destination( &self ) -> Option<&CloudwatchLogsLogDestinationParameters>

The Amazon CloudWatch Logs logging configuration settings for the pipe.

pub fn level(&self) -> &LogLevel

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.

pub fn include_execution_data(&self) -> &[IncludeExecutionDataOption]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .include_execution_data.is_none().

impl PipeLogConfigurationParameters

pub fn builder() -> PipeLogConfigurationParametersBuilder

Creates a new builder-style object to manufacture PipeLogConfigurationParameters.

Trait Implementations

impl Clone for PipeLogConfigurationParameters

fn clone(&self) -> PipeLogConfigurationParameters

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PipeLogConfigurationParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PipeLogConfigurationParameters

fn eq(&self, other: &PipeLogConfigurationParameters) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PipeLogConfigurationParameters