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

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

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

Overview

Note:

When making an API call, you may pass GetRelationalDatabaseLogEventsRequest data as a 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

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

Constraints:

  • Specified in Universal Coordinated 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)


4391
4392
4393
4394
4395
4396
4397
4398
4399
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4391

class GetRelationalDatabaseLogEventsRequest < Struct.new(
  :relational_database_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :start_from_head,
  :page_token)
  include Aws::Structure
end

#log_stream_nameString

The name of the log stream.

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

Returns:

  • (String)


4391
4392
4393
4394
4395
4396
4397
4398
4399
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4391

class GetRelationalDatabaseLogEventsRequest < Struct.new(
  :relational_database_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :start_from_head,
  :page_token)
  include Aws::Structure
end

#page_tokenString

A token used for advancing to a specific page of results for your get relational database log events request.

Returns:

  • (String)


4391
4392
4393
4394
4395
4396
4397
4398
4399
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4391

class GetRelationalDatabaseLogEventsRequest < Struct.new(
  :relational_database_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :start_from_head,
  :page_token)
  include Aws::Structure
end

#relational_database_nameString

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

Returns:

  • (String)


4391
4392
4393
4394
4395
4396
4397
4398
4399
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4391

class GetRelationalDatabaseLogEventsRequest < Struct.new(
  :relational_database_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :start_from_head,
  :page_token)
  include Aws::Structure
end

#start_from_headBoolean

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.

Default: false

Returns:

  • (Boolean)


4391
4392
4393
4394
4395
4396
4397
4398
4399
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4391

class GetRelationalDatabaseLogEventsRequest < Struct.new(
  :relational_database_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :start_from_head,
  :page_token)
  include Aws::Structure
end

#start_timeTime

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

Constraints:

  • Specified in Universal Coordinated 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)


4391
4392
4393
4394
4395
4396
4397
4398
4399
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4391

class GetRelationalDatabaseLogEventsRequest < Struct.new(
  :relational_database_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :start_from_head,
  :page_token)
  include Aws::Structure
end