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

Class: Aws::Lightsail::Types::GetRelationalDatabaseMetricDataRequest

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 GetRelationalDatabaseMetricDataRequest data as a hash:

{
  relational_database_name: "ResourceName", # required
  metric_name: "CPUUtilization", # required, accepts CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, NetworkTransmitThroughput
  period: 1, # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  unit: "Seconds", # required, accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
  statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
}

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

The end of the time interval from which to get metric data.

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)


4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4565

class GetRelationalDatabaseMetricDataRequest < Struct.new(
  :relational_database_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#metric_nameString

The name of the metric data to return.

Returns:

  • (String)


4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4565

class GetRelationalDatabaseMetricDataRequest < Struct.new(
  :relational_database_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#periodInteger

The granularity, in seconds, of the returned data points.

Returns:

  • (Integer)


4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4565

class GetRelationalDatabaseMetricDataRequest < Struct.new(
  :relational_database_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#relational_database_nameString

The name of your database from which to get metric data.

Returns:

  • (String)


4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4565

class GetRelationalDatabaseMetricDataRequest < Struct.new(
  :relational_database_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#start_timeTime

The start of the time interval from which to get metric data.

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)


4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4565

class GetRelationalDatabaseMetricDataRequest < Struct.new(
  :relational_database_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#statisticsArray<String>

The array of statistics for your metric data request.

Returns:

  • (Array<String>)


4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4565

class GetRelationalDatabaseMetricDataRequest < Struct.new(
  :relational_database_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#unitString

The unit for the metric data request.

Returns:

  • (String)


4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4565

class GetRelationalDatabaseMetricDataRequest < Struct.new(
  :relational_database_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end