Package software.amazon.awscdk.services.iot

Interface CfnJobTemplate.JobExecutionsRolloutConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobTemplate.JobExecutionsRolloutConfigProperty.Jsii$Proxy

Enclosing class:

CfnJobTemplate

@Stability(Stable)
public static interface CfnJobTemplate.JobExecutionsRolloutConfigProperty
extends software.amazon.jsii.JsiiSerializable

Allows you to create a staged rollout of 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.*;
 JobExecutionsRolloutConfigProperty jobExecutionsRolloutConfigProperty = JobExecutionsRolloutConfigProperty.builder()
         .exponentialRolloutRate(ExponentialRolloutRateProperty.builder()
                 .baseRatePerMinute(123)
                 .incrementFactor(123)
                 .rateIncreaseCriteria(RateIncreaseCriteriaProperty.builder()
                         .numberOfNotifiedThings(123)
                         .numberOfSucceededThings(123)
                         .build())
                 .build())
         .maximumPerMinute(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobTemplate.JobExecutionsRolloutConfigProperty.Builder	builder()
default Object	getExponentialRolloutRate()	The rate of increase for a job rollout.
default Number	getMaximumPerMinute()	The maximum number of things that will be notified of a pending job, per minute.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExponentialRolloutRate

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

The rate of increase for a job rollout.

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

Returns union: either IResolvable or CfnJobTemplate.ExponentialRolloutRateProperty

See Also:

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

getMaximumPerMinute

@Stability(Stable)
@Nullable
default Number getMaximumPerMinute()

The maximum number of things that will be notified of a pending job, per minute.

This parameter allows you to create a staged rollout.

See Also:

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

builder

@Stability(Stable)
static CfnJobTemplate.JobExecutionsRolloutConfigProperty.Builder builder()

Returns:

a CfnJobTemplate.JobExecutionsRolloutConfigProperty.Builder of CfnJobTemplate.JobExecutionsRolloutConfigProperty