Class CloudWatchLogsLogStream
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CloudWatchLogsLogStream.Builder,
CloudWatchLogsLogStream>
Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
Specifies the max number of log events in a batch, up to 10000.final Integer
Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes.final Integer
Specifies the time duration for the batching of log events.builder()
final String
Specifies how the time stamp is extracted from logs.final CloudWatchLogsEncoding
encoding()
Specifies the encoding of the log file so that the file can be read correctly.final String
Specifies the encoding of the log file so that the file can be read correctly.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
file()
Specifies log files that you want to push to CloudWatch Logs.final String
Specifies the range of lines for identifying a file.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
Specifies where to start to read data (start_of_file or end_of_file).final String
Specifies where to start to read data (start_of_file or end_of_file).final String
Specifies the destination log group.final String
Specifies the pattern for identifying the start of a log message.static Class
<? extends CloudWatchLogsLogStream.Builder> final CloudWatchLogsTimeZone
timeZone()
Specifies the time zone of log event time stamps.final String
Specifies the time zone of log event time stamps.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
- 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).
-
datetimeFormat
Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
- Returns:
- Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
-
timeZone
Specifies the time zone of log event time stamps.
If the service returns an enum value that is not available in the current SDK version,
timeZone
will returnCloudWatchLogsTimeZone.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtimeZoneAsString()
.- Returns:
- Specifies the time zone of log event time stamps.
- See Also:
-
timeZoneAsString
Specifies the time zone of log event time stamps.
If the service returns an enum value that is not available in the current SDK version,
timeZone
will returnCloudWatchLogsTimeZone.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtimeZoneAsString()
.- Returns:
- Specifies the time zone of log event time stamps.
- See Also:
-
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 asaccess_log.2014-06-01-01
,access_log.2014-06-01-02
, and so on by using a pattern likeaccess_log.*
. Don't use a wildcard to match multiple file types, such asaccess_log_80
andaccess_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:
- 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 asaccess_log.2014-06-01-01
,access_log.2014-06-01-02
, and so on by using a pattern likeaccess_log.*
. Don't use a wildcard to match multiple file types, such asaccess_log_80
andaccess_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.
-
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:
- 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.
-
multiLineStartPattern
Specifies the pattern for identifying the start of a log message.
- Returns:
- Specifies the pattern for identifying the start of a log message.
-
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.
If the service returns an enum value that is not available in the current SDK version,
initialPosition
will returnCloudWatchLogsInitialPosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominitialPositionAsString()
.- Returns:
- 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.
- See Also:
-
initialPositionAsString
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.
If the service returns an enum value that is not available in the current SDK version,
initialPosition
will returnCloudWatchLogsInitialPosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominitialPositionAsString()
.- Returns:
- 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.
- See Also:
-
encoding
Specifies the encoding of the log file so that the file can be read correctly. The default is
utf_8
. Encodings supported by Pythoncodecs.decode()
can be used here.If the service returns an enum value that is not available in the current SDK version,
encoding
will returnCloudWatchLogsEncoding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingAsString()
.- Returns:
- Specifies the encoding of the log file so that the file can be read correctly. The default is
utf_8
. Encodings supported by Pythoncodecs.decode()
can be used here. - See Also:
-
encodingAsString
Specifies the encoding of the log file so that the file can be read correctly. The default is
utf_8
. Encodings supported by Pythoncodecs.decode()
can be used here.If the service returns an enum value that is not available in the current SDK version,
encoding
will returnCloudWatchLogsEncoding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingAsString()
.- Returns:
- Specifies the encoding of the log file so that the file can be read correctly. The default is
utf_8
. Encodings supported by Pythoncodecs.decode()
can be used here. - See Also:
-
bufferDuration
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
- Returns:
- Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
-
batchCount
Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
- Returns:
- Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CloudWatchLogsLogStream.Builder,
CloudWatchLogsLogStream> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-