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

Class: Aws::StorageGateway::Types::BandwidthRateLimitInterval

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

Overview

Note:

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

{
  start_hour_of_day: 1, # required
  start_minute_of_hour: 1, # required
  end_hour_of_day: 1, # required
  end_minute_of_hour: 1, # required
  days_of_week: [1], # required
  average_upload_rate_limit_in_bits_per_sec: 1,
  average_download_rate_limit_in_bits_per_sec: 1,
}

Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#average_download_rate_limit_in_bits_per_sec ⇒ Integer

The average download rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the download rate limit is not set.

Returns:

  • (Integer) —

    The average download rate limit component of the bandwidth rate limit interval, in bits per second.

#average_upload_rate_limit_in_bits_per_sec ⇒ Integer

The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.

Returns:

  • (Integer) —

    The average upload rate limit component of the bandwidth rate limit interval, in bits per second.

#days_of_week ⇒ Array<Integer>

The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 Saturday.

Returns:

  • (Array<Integer>) —

    The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 Saturday.

#end_hour_of_day ⇒ Integer

The hour of the day to end the bandwidth rate limit interval.

Returns:

  • (Integer) —

    The hour of the day to end the bandwidth rate limit interval.

#end_minute_of_hour ⇒ Integer

The minute of the hour to end the bandwidth rate limit interval.

The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59.

Returns:

  • (Integer) —

    The minute of the hour to end the bandwidth rate limit interval.

#start_hour_of_day ⇒ Integer

The hour of the day to start the bandwidth rate limit interval.

Returns:

  • (Integer) —

    The hour of the day to start the bandwidth rate limit interval.

#start_minute_of_hour ⇒ Integer

The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.

Returns:

  • (Integer) —

    The minute of the hour to start the bandwidth rate limit interval.