You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::ExponentialRolloutRate
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::ExponentialRolloutRate
- Defined in:
- (unknown)
Overview
When passing ExponentialRolloutRate as input to an Aws::Client method, you can use a vanilla 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.
Returned by:
Instance Attribute Summary collapse
-
#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.
-
#increment_factor ⇒ Float
The exponential factor to increase the rate of rollout for a job.
-
#rate_increase_criteria ⇒ Types::RateIncreaseCriteria
The criteria to initiate the increase in rate of rollout for a job.
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.
#increment_factor ⇒ Float
The exponential factor to increase the rate of rollout for a job.
AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).
#rate_increase_criteria ⇒ Types::RateIncreaseCriteria
The criteria to initiate the increase in rate of rollout for a job.