You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::OpsWorks::Types::CloudWatchLogsLogStream

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

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,
}

Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.

Instance Attribute Summary collapse

Instance Attribute Details

#batch_countInteger

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

Returns:

  • (Integer)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end

#batch_sizeInteger

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:

  • (Integer)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end

#buffer_durationInteger

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

Returns:

  • (Integer)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end

#datetime_formatString

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

Returns:

  • (String)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end

#encodingString

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:

  • (String)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end

#fileString

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:

  • (String)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end

#file_fingerprint_linesString

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:

  • (String)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end

#initial_positionString

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:

  • (String)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end

#log_group_nameString

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:

  • (String)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end

#multi_line_start_patternString

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

Returns:

  • (String)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end

#time_zoneString

Specifies the time zone of log event time stamps.

Returns:

  • (String)


949
950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 949

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  include Aws::Structure
end