aws-cdk-lib.aws_iot.CfnJobTemplate.ExponentialRolloutRateProperty

interface ExponentialRolloutRateProperty

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnJobTemplate.ExponentialRolloutRateProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnJobTemplate_ExponentialRolloutRateProperty
Javasoftware.amazon.awscdk.services.iot.CfnJobTemplate.ExponentialRolloutRateProperty
Pythonaws_cdk.aws_iot.CfnJobTemplate.ExponentialRolloutRateProperty
TypeScript aws-cdk-lib » aws_iot » CfnJobTemplate » ExponentialRolloutRateProperty

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 { aws_iot as iot } from 'aws-cdk-lib';
const exponentialRolloutRateProperty: iot.CfnJobTemplate.ExponentialRolloutRateProperty = {
  baseRatePerMinute: 123,
  incrementFactor: 123,
  rateIncreaseCriteria: {
    numberOfNotifiedThings: 123,
    numberOfSucceededThings: 123,
  },
};

Properties

NameTypeDescription
baseRatePerMinutenumberThe minimum number of things that will be notified of a pending job, per minute at the start of job rollout.
incrementFactornumberThe exponential factor to increase the rate of rollout for a job.
rateIncreaseCriteriaIResolvable | RateIncreaseCriteriaPropertyThe criteria to initiate the increase in rate of rollout for a job.

baseRatePerMinute

Type: number

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.


incrementFactor

Type: number

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).


rateIncreaseCriteria

Type: IResolvable | RateIncreaseCriteriaProperty

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