Package software.amazon.awscdk.services.iot

Interface CfnJob.ExponentialRolloutRateProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJob.ExponentialRolloutRateProperty.Jsii$Proxy

Enclosing class:

CfnJob

@Stability(Stable)
public static interface CfnJob.ExponentialRolloutRateProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 ExponentialRolloutRateProperty exponentialRolloutRateProperty = ExponentialRolloutRateProperty.builder()
         .baseRatePerMinute(123)
         .incrementFactor(123)
         .rateIncreaseCriteria(RateIncreaseCriteriaProperty.builder()
                 .numberOfNotifiedThings(123)
                 .numberOfSucceededThings(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-exponentialrolloutrate.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJob.ExponentialRolloutRateProperty.Builder	A builder for CfnJob.ExponentialRolloutRateProperty
static final class	CfnJob.ExponentialRolloutRateProperty.Jsii$Proxy	An implementation for CfnJob.ExponentialRolloutRateProperty

Method Summary

Modifier and Type	Method	Description
static CfnJob.ExponentialRolloutRateProperty.Builder	builder()
Number	getBaseRatePerMinute()	The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.
Number	getIncrementFactor()	The exponential factor to increase the rate of rollout for a job.
Object	getRateIncreaseCriteria()	Allows you to define a criteria to initiate the increase in rate of rollout for a job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-exponentialrolloutrate.html#cfn-iot-job-exponentialrolloutrate-baserateperminute

getIncrementFactor

@Stability(Stable)
@NotNull
Number getIncrementFactor()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-exponentialrolloutrate.html#cfn-iot-job-exponentialrolloutrate-incrementfactor

getRateIncreaseCriteria

@Stability(Stable)
@NotNull
Object getRateIncreaseCriteria()

Allows you to define a criteria to initiate the increase in rate of rollout for a job.

Returns union: either IResolvable or CfnJob.RateIncreaseCriteriaProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-job-exponentialrolloutrate.html#cfn-iot-job-exponentialrolloutrate-rateincreasecriteria

builder

@Stability(Stable)
static CfnJob.ExponentialRolloutRateProperty.Builder builder()

Returns:

a CfnJob.ExponentialRolloutRateProperty.Builder of CfnJob.ExponentialRolloutRateProperty