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

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

Overview

Note:

When making an API call, you may pass AwsJobExponentialRolloutRate 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,
  },
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#base_rate_per_minuteInteger

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)


1613
1614
1615
1616
1617
1618
1619
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1613

class AwsJobExponentialRolloutRate < Struct.new(
  :base_rate_per_minute,
  :increment_factor,
  :rate_increase_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#increment_factorFloat

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

Returns:

  • (Float)


1613
1614
1615
1616
1617
1618
1619
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1613

class AwsJobExponentialRolloutRate < Struct.new(
  :base_rate_per_minute,
  :increment_factor,
  :rate_increase_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#rate_increase_criteriaTypes::AwsJobRateIncreaseCriteria

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

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).



1613
1614
1615
1616
1617
1618
1619
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1613

class AwsJobExponentialRolloutRate < Struct.new(
  :base_rate_per_minute,
  :increment_factor,
  :rate_increase_criteria)
  SENSITIVE = []
  include Aws::Structure
end