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

Class: Aws::RDS::DBLogFile

Inherits:
Aws::Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Aws::Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Aws::Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Aws::Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(instance_id, name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(instance_id, name, options = {}) ⇒ Object

    Parameters:

    • instance_id (String)
    • name (String)

    Options Hash (options):

    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :instance_id (required, String)
    • :name (required, String)
    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#instance_id ⇒ String (readonly)

Returns:

  • (String)

#last_written ⇒ Integer (readonly)

A POSIX timestamp when the last log entry was written.

Returns:

  • (Integer) —

    A POSIX timestamp when the last log entry was written.

#log_file_name ⇒ String (readonly)

The name of the log file for the specified DB instance.

Returns:

  • (String) —

    The name of the log file for the specified DB instance.

#name ⇒ String (readonly)

Returns:

  • (String)

#size ⇒ Integer (readonly)

The size, in bytes, of the log file for the specified DB instance.

Returns:

  • (Integer) —

    The size, in bytes, of the log file for the specified DB instance.

Instance Method Details

#download(options = {}) ⇒ Types::DownloadDBLogFilePortionDetails

Downloads all or a portion of the specified log file, up to 1 MB in size.

Examples:

Request syntax example with placeholder values


dblogfile.download({
  marker: "String",
  number_of_lines: 1,
})

Options Hash (options):

  • :marker (String) —

    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.

  • :number_of_lines (Integer) —

    The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is 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 isn\'t 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:

See Also: