software.amazon.awssdk.services.opsworks.model

Interface CloudWatchLogsLogStream.Builder

All Superinterfaces:

CopyableBuilder<CloudWatchLogsLogStream.Builder,CloudWatchLogsLogStream>, SdkBuilder<CloudWatchLogsLogStream.Builder,CloudWatchLogsLogStream>

Enclosing class:

CloudWatchLogsLogStream

public static interface CloudWatchLogsLogStream.Builder
extends CopyableBuilder<CloudWatchLogsLogStream.Builder,CloudWatchLogsLogStream>

Method Summary

Modifier and Type	Method and Description
CloudWatchLogsLogStream.Builder	batchCount(Integer batchCount) Specifies the max number of log events in a batch, up to 10000.
CloudWatchLogsLogStream.Builder	batchSize(Integer batchSize) Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes.
CloudWatchLogsLogStream.Builder	bufferDuration(Integer bufferDuration) Specifies the time duration for the batching of log events.
CloudWatchLogsLogStream.Builder	datetimeFormat(String datetimeFormat) Specifies how the time stamp is extracted from logs.
CloudWatchLogsLogStream.Builder	encoding(CloudWatchLogsEncoding encoding) Specifies the encoding of the log file so that the file can be read correctly.
CloudWatchLogsLogStream.Builder	encoding(String encoding) Specifies the encoding of the log file so that the file can be read correctly.
CloudWatchLogsLogStream.Builder	file(String file) Specifies log files that you want to push to CloudWatch Logs.
CloudWatchLogsLogStream.Builder	fileFingerprintLines(String fileFingerprintLines) Specifies the range of lines for identifying a file.
CloudWatchLogsLogStream.Builder	initialPosition(CloudWatchLogsInitialPosition initialPosition) Specifies where to start to read data (start_of_file or end_of_file).
CloudWatchLogsLogStream.Builder	initialPosition(String initialPosition) Specifies where to start to read data (start_of_file or end_of_file).
CloudWatchLogsLogStream.Builder	logGroupName(String logGroupName) Specifies the destination log group.
CloudWatchLogsLogStream.Builder	multiLineStartPattern(String multiLineStartPattern) Specifies the pattern for identifying the start of a log message.
CloudWatchLogsLogStream.Builder	timeZone(CloudWatchLogsTimeZone timeZone) Specifies the time zone of log event time stamps.
CloudWatchLogsLogStream.Builder	timeZone(String timeZone) Specifies the time zone of log event time stamps.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

logGroupName

CloudWatchLogsLogStream.Builder logGroupName(String logGroupName)

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Parameters:

logGroupName - Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Returns:

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

datetimeFormat

CloudWatchLogsLogStream.Builder datetimeFormat(String datetimeFormat)

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

Parameters:

datetimeFormat - Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

Returns:

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

timeZone

CloudWatchLogsLogStream.Builder timeZone(String timeZone)

Specifies the time zone of log event time stamps.

Parameters:

timeZone - Specifies the time zone of log event time stamps.

Returns:

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

See Also:

CloudWatchLogsTimeZone, CloudWatchLogsTimeZone

timeZone

CloudWatchLogsLogStream.Builder timeZone(CloudWatchLogsTimeZone timeZone)

Specifies the time zone of log event time stamps.

Parameters:

timeZone - Specifies the time zone of log event time stamps.

Returns:

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

See Also:

CloudWatchLogsTimeZone, CloudWatchLogsTimeZone

file

CloudWatchLogsLogStream.Builder file(String file)

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Parameters:

file - Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Returns:

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

fileFingerprintLines

CloudWatchLogsLogStream.Builder fileFingerprintLines(String fileFingerprintLines)

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Parameters:

fileFingerprintLines - Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Returns:

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

multiLineStartPattern

CloudWatchLogsLogStream.Builder multiLineStartPattern(String multiLineStartPattern)

Specifies the pattern for identifying the start of a log message.

Parameters:

multiLineStartPattern - Specifies the pattern for identifying the start of a log message.

Returns:

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

initialPosition

CloudWatchLogsLogStream.Builder initialPosition(String initialPosition)

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Parameters:

initialPosition - Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Returns:

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

See Also:

CloudWatchLogsInitialPosition, CloudWatchLogsInitialPosition

initialPosition

CloudWatchLogsLogStream.Builder initialPosition(CloudWatchLogsInitialPosition initialPosition)

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Parameters:

initialPosition - Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Returns:

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

See Also:

CloudWatchLogsInitialPosition, CloudWatchLogsInitialPosition

encoding

CloudWatchLogsLogStream.Builder encoding(String encoding)

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

Parameters:

encoding - Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

Returns:

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

See Also:

CloudWatchLogsEncoding, CloudWatchLogsEncoding

encoding

CloudWatchLogsLogStream.Builder encoding(CloudWatchLogsEncoding encoding)

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

Parameters:

encoding - Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

Returns:

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

See Also:

CloudWatchLogsEncoding, CloudWatchLogsEncoding

bufferDuration

CloudWatchLogsLogStream.Builder bufferDuration(Integer bufferDuration)

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

Parameters:

bufferDuration - Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

Returns:

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

batchCount

CloudWatchLogsLogStream.Builder batchCount(Integer batchCount)

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

Parameters:

batchCount - Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

Returns:

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

batchSize

CloudWatchLogsLogStream.Builder batchSize(Integer batchSize)

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

Parameters:

batchSize - Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

Returns:

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