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

Class: Aws::Lightsail::Types::GetRelationalDatabaseLogEventsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetRelationalDatabaseLogEventsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  relational_database_name: "ResourceName", # required
  log_stream_name: "string", # required
  start_time: Time.now,
  end_time: Time.now,
  start_from_head: false,
  page_token: "string",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

The end of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

Returns:

  • (Time) —

    The end of the time interval from which to get log events.

#log_stream_name ⇒ String

The name of the log stream.

Use the get relational database log streams operation to get a list of available log streams.

Returns:

  • (String) —

    The name of the log stream.

#page_token ⇒ String

The token to advance to the next or previous page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseLogEvents request. If your results are paginated, the response will return a next forward token and/or next backward token that you can specify as the page token in a subsequent request.

Returns:

  • (String) —

    The token to advance to the next or previous page of results from your request.

#relational_database_name ⇒ String

The name of your database for which to get log events.

Returns:

  • (String) —

    The name of your database for which to get log events.

#start_from_head ⇒ Boolean

Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log.

For PostgreSQL, the default value of false is the only option available.

Returns:

  • (Boolean) —

    Parameter to specify if the log should start from head or tail.

#start_time ⇒ Time

The start of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

Returns:

  • (Time) —

    The start of the time interval from which to get log events.