Class: Aws::IoT::Types::ExponentialRolloutRate

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass ExponentialRolloutRate data as a hash:

{
  base_rate_per_minute: 1, # required
  increment_factor: 1.0, # required
  rate_increase_criteria: { # required
    number_of_notified_things: 1,
    number_of_succeeded_things: 1,
  },
}

Allows you to create an exponential rate of rollout for a job.

Instance Attribute Summary collapse

Instance Attribute Details

#base_rate_per_minute ⇒ Integer

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

Returns:

  • (Integer) 


4908
4909
4910
4911
4912
4913
 
# File 'lib/aws-sdk-iot/types.rb', line 4908

class ExponentialRolloutRate < Struct.new(
  :base_rate_per_minute,
  :increment_factor,
  :rate_increase_criteria)
  include Aws::Structure
end

#increment_factor ⇒ Float

The exponential factor to increase the rate of rollout for a job.

Returns:

  • (Float) 


4908
4909
4910
4911
4912
4913
 
# File 'lib/aws-sdk-iot/types.rb', line 4908

class ExponentialRolloutRate < Struct.new(
  :base_rate_per_minute,
  :increment_factor,
  :rate_increase_criteria)
  include Aws::Structure
end

#rate_increase_criteria ⇒ Types::RateIncreaseCriteria

The criteria to initiate the increase in rate of rollout for a job.

AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

Returns:



4908
4909
4910
4911
4912
4913
 
# File 'lib/aws-sdk-iot/types.rb', line 4908

class ExponentialRolloutRate < Struct.new(
  :base_rate_per_minute,
  :increment_factor,
  :rate_increase_criteria)
  include Aws::Structure
end