Package software.amazon.awscdk.cfnpropertymixins.services.iot

Interface CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty.Jsii$Proxy

Enclosing class:

CfnJobTemplatePropsMixin

@Stability(Stable)
public static interface CfnJobTemplatePropsMixin.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.cfnpropertymixins.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-jobtemplate-exponentialrolloutrate.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty.Builder	builder()
default Number	getBaseRatePerMinute()	The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.
default Number	getIncrementFactor()	The exponential factor to increase the rate of rollout for a job.
default Object	getRateIncreaseCriteria()	The 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)
@Nullable
default 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.

See Also:

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

getIncrementFactor

@Stability(Stable)
@Nullable
default 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).

See Also:

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

getRateIncreaseCriteria

@Stability(Stable)
@Nullable
default Object getRateIncreaseCriteria()

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

Returns union: either IResolvable or CfnJobTemplatePropsMixin.RateIncreaseCriteriaProperty

See Also:

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

builder

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

Returns:

a CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty.Builder of CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty