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

Class: Aws::IoT::Types::AwsJobExponentialRolloutRate

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

Overview

Note:

When passing AwsJobExponentialRolloutRate 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,
  },
}

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

Returned by:

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 the job rollout. This is the initial rate of the rollout.

Returns:

  • (Integer) —

    The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout.

#increment_factor ⇒ Float

The rate of increase for a job rollout. The number of things notified is multiplied by this factor.

Returns:

  • (Float) —

    The rate of increase for a job rollout.

#rate_increase_criteria ⇒ Types::AwsJobRateIncreaseCriteria

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: