com.amazonaws.services.pipes.model

Class PipeLogConfigurationParameters

java.lang.Object

com.amazonaws.services.pipes.model.PipeLogConfigurationParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipeLogConfigurationParameters
extends Object
implements Serializable, Cloneable, StructuredPojo

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PipeLogConfigurationParameters()

Method Summary

Modifier and Type	Method and Description
PipeLogConfigurationParameters	clone()
boolean	equals(Object obj)
CloudwatchLogsLogDestinationParameters	getCloudwatchLogsLogDestination() The Amazon CloudWatch Logs logging configuration settings for the pipe.
FirehoseLogDestinationParameters	getFirehoseLogDestination() The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
List<String>	getIncludeExecutionData() Specify ON to include the execution data (specifically, the payload and awsRequest fields) in the log messages for this pipe.
String	getLevel() The level of logging detail to include.
S3LogDestinationParameters	getS3LogDestination() The Amazon S3 logging configuration settings for the pipe.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCloudwatchLogsLogDestination(CloudwatchLogsLogDestinationParameters cloudwatchLogsLogDestination) The Amazon CloudWatch Logs logging configuration settings for the pipe.
void	setFirehoseLogDestination(FirehoseLogDestinationParameters firehoseLogDestination) The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
void	setIncludeExecutionData(Collection<String> includeExecutionData) Specify ON to include the execution data (specifically, the payload and awsRequest fields) in the log messages for this pipe.
void	setLevel(String level) The level of logging detail to include.
void	setS3LogDestination(S3LogDestinationParameters s3LogDestination) The Amazon S3 logging configuration settings for the pipe.
String	toString() Returns a string representation of this object.
PipeLogConfigurationParameters	withCloudwatchLogsLogDestination(CloudwatchLogsLogDestinationParameters cloudwatchLogsLogDestination) The Amazon CloudWatch Logs logging configuration settings for the pipe.
PipeLogConfigurationParameters	withFirehoseLogDestination(FirehoseLogDestinationParameters firehoseLogDestination) The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
PipeLogConfigurationParameters	withIncludeExecutionData(Collection<String> includeExecutionData) Specify ON to include the execution data (specifically, the payload and awsRequest fields) in the log messages for this pipe.
PipeLogConfigurationParameters	withIncludeExecutionData(IncludeExecutionDataOption... includeExecutionData) Specify ON to include the execution data (specifically, the payload and awsRequest fields) in the log messages for this pipe.
PipeLogConfigurationParameters	withIncludeExecutionData(String... includeExecutionData) Specify ON to include the execution data (specifically, the payload and awsRequest fields) in the log messages for this pipe.
PipeLogConfigurationParameters	withLevel(LogLevel level) The level of logging detail to include.
PipeLogConfigurationParameters	withLevel(String level) The level of logging detail to include.
PipeLogConfigurationParameters	withS3LogDestination(S3LogDestinationParameters s3LogDestination) The Amazon S3 logging configuration settings for the pipe.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PipeLogConfigurationParameters

public PipeLogConfigurationParameters()

Method Detail

setCloudwatchLogsLogDestination

public void setCloudwatchLogsLogDestination(CloudwatchLogsLogDestinationParameters cloudwatchLogsLogDestination)

The Amazon CloudWatch Logs logging configuration settings for the pipe.

Parameters:

cloudwatchLogsLogDestination - The Amazon CloudWatch Logs logging configuration settings for the pipe.

getCloudwatchLogsLogDestination

public CloudwatchLogsLogDestinationParameters getCloudwatchLogsLogDestination()

The Amazon CloudWatch Logs logging configuration settings for the pipe.

Returns:

The Amazon CloudWatch Logs logging configuration settings for the pipe.

withCloudwatchLogsLogDestination

public PipeLogConfigurationParameters withCloudwatchLogsLogDestination(CloudwatchLogsLogDestinationParameters cloudwatchLogsLogDestination)

The Amazon CloudWatch Logs logging configuration settings for the pipe.

Parameters:

cloudwatchLogsLogDestination - The Amazon CloudWatch Logs logging configuration settings for the pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFirehoseLogDestination

public void setFirehoseLogDestination(FirehoseLogDestinationParameters firehoseLogDestination)

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

Parameters:

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

getFirehoseLogDestination

public FirehoseLogDestinationParameters getFirehoseLogDestination()

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

Returns:

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

withFirehoseLogDestination

public PipeLogConfigurationParameters withFirehoseLogDestination(FirehoseLogDestinationParameters firehoseLogDestination)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getIncludeExecutionData

public List<String> getIncludeExecutionData()

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.

Returns:

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.

See Also:

IncludeExecutionDataOption

setIncludeExecutionData

public void setIncludeExecutionData(Collection<String> includeExecutionData)

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.

Parameters:

includeExecutionData - 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.

See Also:

IncludeExecutionDataOption

withIncludeExecutionData

public PipeLogConfigurationParameters withIncludeExecutionData(String... includeExecutionData)

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.

NOTE: This method appends the values to the existing list (if any). Use setIncludeExecutionData(java.util.Collection) or withIncludeExecutionData(java.util.Collection) if you want to override the existing values.

Parameters:

includeExecutionData - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IncludeExecutionDataOption

withIncludeExecutionData

public PipeLogConfigurationParameters withIncludeExecutionData(Collection<String> includeExecutionData)

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.

Parameters:

includeExecutionData - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IncludeExecutionDataOption

withIncludeExecutionData

public PipeLogConfigurationParameters withIncludeExecutionData(IncludeExecutionDataOption... includeExecutionData)

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.

Parameters:

includeExecutionData - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IncludeExecutionDataOption

setLevel

public void setLevel(String 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.

Parameters:

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.

See Also:

LogLevel

getLevel

public String getLevel()

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.

Returns:

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.

See Also:

LogLevel

withLevel

public PipeLogConfigurationParameters withLevel(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LogLevel

withLevel

public PipeLogConfigurationParameters withLevel(LogLevel 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LogLevel

setS3LogDestination

public void setS3LogDestination(S3LogDestinationParameters s3LogDestination)

The Amazon S3 logging configuration settings for the pipe.

Parameters:

s3LogDestination - The Amazon S3 logging configuration settings for the pipe.

getS3LogDestination

public S3LogDestinationParameters getS3LogDestination()

The Amazon S3 logging configuration settings for the pipe.

Returns:

The Amazon S3 logging configuration settings for the pipe.

withS3LogDestination

public PipeLogConfigurationParameters withS3LogDestination(S3LogDestinationParameters s3LogDestination)

The Amazon S3 logging configuration settings for the pipe.

Parameters:

s3LogDestination - The Amazon S3 logging configuration settings for the pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PipeLogConfigurationParameters clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo