Interface CfnJobTemplate.IExponentialRolloutRateProperty

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

Namespace: Amazon.CDK.AWS.IoT

Assembly: Amazon.CDK.AWS.IoT.dll

Syntax (csharp)

public interface IExponentialRolloutRateProperty

Syntax (vb)

Public Interface IExponentialRolloutRateProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;

var exponentialRolloutRateProperty = new ExponentialRolloutRateProperty {
    BaseRatePerMinute = 123,
    IncrementFactor = 123,
    RateIncreaseCriteria = new RateIncreaseCriteriaProperty {
        NumberOfNotifiedThings = 123,
        NumberOfSucceededThings = 123
    }
};

Synopsis

Properties

BaseRatePerMinute	The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.
IncrementFactor	The exponential factor to increase the rate of rollout for a job.
RateIncreaseCriteria	The criteria to initiate the increase in rate of rollout for a job.

Properties

BaseRatePerMinute

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.

double BaseRatePerMinute { get; }

Property Value

System.Double

Remarks

This parameter allows you to define the initial rate of rollout.

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

IncrementFactor

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

double IncrementFactor { get; }

Property Value

System.Double

Remarks

AWS IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

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

RateIncreaseCriteria

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

object RateIncreaseCriteria { get; }

Property Value

System.Object

Remarks

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