Interface CfnJobTemplate.ExponentialRolloutRateProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnJobTemplate.ExponentialRolloutRateProperty extends
Allows you to create an exponential rate of rollout for a job.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 ExponentialRolloutRateProperty exponentialRolloutRateProperty = ExponentialRolloutRateProperty.builder()
  • Method Details

    • getBaseRatePerMinute

      @Stability(Stable) @NotNull Number getBaseRatePerMinute()
      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.

    • getIncrementFactor

      @Stability(Stable) @NotNull Number getIncrementFactor()
      The exponential factor to increase the rate of rollout for a job.

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

    • getRateIncreaseCriteria

      @Stability(Stable) @NotNull Object getRateIncreaseCriteria()
      The criteria to initiate the increase in rate of rollout for a job.
    • builder

      @Stability(Stable) static CfnJobTemplate.ExponentialRolloutRateProperty.Builder builder()
      a CfnJobTemplate.ExponentialRolloutRateProperty.Builder of CfnJobTemplate.ExponentialRolloutRateProperty