interface ExponentialRolloutRateProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.IoT.Mixins.CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiot/mixins#CfnJobTemplatePropsMixin_ExponentialRolloutRateProperty`
Java	`software.amazon.awscdk.mixins.preview.services.iot.mixins.CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty`
Python	`aws_cdk.mixins_preview.aws_iot.mixins.CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_iot` » `mixins` » `CfnJobTemplatePropsMixin` » `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 { mixins as iot_mixins } from '@aws-cdk/mixins-preview/aws-iot';
const exponentialRolloutRateProperty: iot_mixins.CfnJobTemplatePropsMixin.ExponentialRolloutRateProperty = {
  baseRatePerMinute: 123,
  incrementFactor: 123,
  rateIncreaseCriteria: {
    numberOfNotifiedThings: 123,
    numberOfSucceededThings: 123,
  },
};

Properties

Name	Type	Description
baseRatePerMinute?	`number`	The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.
incrementFactor?	`number`	The exponential factor to increase the rate of rollout for a job.
rateIncreaseCriteria?	`IResolvable` `\|` `RateIncreaseCriteriaProperty`	The criteria to initiate the increase in rate of rollout for a job.

baseRatePerMinute?

Type: number (optional)

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 (optional)

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 (optional)

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

AWS CDK