class Aws::OpsWorks::Types::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].
[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html
@note When making an API call, you may pass CloudWatchLogsLogStream
data as a hash: { log_group_name: "String", datetime_format: "String", time_zone: "LOCAL", # accepts LOCAL, UTC file: "String", file_fingerprint_lines: "String", multi_line_start_pattern: "String", initial_position: "start_of_file", # accepts start_of_file, end_of_file encoding: "ascii", # accepts ascii, big5, big5hkscs, cp037, cp424, cp437, cp500, cp720, cp737, cp775, cp850, cp852, cp855, cp856, cp857, cp858, cp860, cp861, cp862, cp863, cp864, cp865, cp866, cp869, cp874, cp875, cp932, cp949, cp950, cp1006, cp1026, cp1140, cp1250, cp1251, cp1252, cp1253, cp1254, cp1255, cp1256, cp1257, cp1258, euc_jp, euc_jis_2004, euc_jisx0213, euc_kr, gb2312, gbk, gb18030, hz, iso2022_jp, iso2022_jp_1, iso2022_jp_2, iso2022_jp_2004, iso2022_jp_3, iso2022_jp_ext, iso2022_kr, latin_1, iso8859_2, iso8859_3, iso8859_4, iso8859_5, iso8859_6, iso8859_7, iso8859_8, iso8859_9, iso8859_10, iso8859_13, iso8859_14, iso8859_15, iso8859_16, johab, koi8_r, koi8_u, mac_cyrillic, mac_greek, mac_iceland, mac_latin2, mac_roman, mac_turkish, ptcp154, shift_jis, shift_jis_2004, shift_jisx0213, utf_32, utf_32_be, utf_32_le, utf_16, utf_16_be, utf_16_le, utf_7, utf_8, utf_8_sig buffer_duration: 1, batch_count: 1, batch_size: 1, }
@!attribute [rw] log_group_name
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). @return [String]
@!attribute [rw] datetime_format
Specifies how the time stamp is extracted from logs. For more information, see the [CloudWatch Logs Agent Reference][1]. [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html @return [String]
@!attribute [rw] time_zone
Specifies the time zone of log event time stamps. @return [String]
@!attribute [rw] 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. @return [String]
@!attribute [rw] file_fingerprint_lines
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. @return [String]
@!attribute [rw] multi_line_start_pattern
Specifies the pattern for identifying the start of a log message. @return [String]
@!attribute [rw] initial_position
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. @return [String]
@!attribute [rw] 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. @return [String]
@!attribute [rw] buffer_duration
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms. @return [Integer]
@!attribute [rw] batch_count
Specifies the max number of log events in a batch, up to 10000. The default value is 1000. @return [Integer]
@!attribute [rw] batch_size
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. @return [Integer]
@see docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/CloudWatchLogsLogStream AWS API Documentation
Constants
- SENSITIVE