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

Class: Aws::RDS::Types::DownloadDBLogFilePortionMessage

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

Overview

Note:

When making an API call, you may pass DownloadDBLogFilePortionMessage data as a hash:

{
  db_instance_identifier: "String", # required
  log_file_name: "String", # required
  marker: "String",
  number_of_lines: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_identifierString

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

  • Must match the identifier of an existing DBInstance.

^

Returns:

  • (String)


7636
7637
7638
7639
7640
7641
7642
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7636

class DownloadDBLogFilePortionMessage < Struct.new(
  :db_instance_identifier,
  :log_file_name,
  :marker,
  :number_of_lines)
  include Aws::Structure
end

#log_file_nameString

The name of the log file to be downloaded.

Returns:

  • (String)


7636
7637
7638
7639
7640
7641
7642
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7636

class DownloadDBLogFilePortionMessage < Struct.new(
  :db_instance_identifier,
  :log_file_name,
  :marker,
  :number_of_lines)
  include Aws::Structure
end

#markerString

The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

Returns:

  • (String)


7636
7637
7638
7639
7640
7641
7642
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7636

class DownloadDBLogFilePortionMessage < Struct.new(
  :db_instance_identifier,
  :log_file_name,
  :marker,
  :number_of_lines)
  include Aws::Structure
end

#number_of_linesInteger

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file will be truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

  • If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

  • If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.

  • If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.

  • You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

Returns:

  • (Integer)


7636
7637
7638
7639
7640
7641
7642
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7636

class DownloadDBLogFilePortionMessage < Struct.new(
  :db_instance_identifier,
  :log_file_name,
  :marker,
  :number_of_lines)
  include Aws::Structure
end