Package software.amazon.awscdk.services.iot

Interface CfnJobTemplate.TimeoutConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobTemplate.TimeoutConfigProperty.Jsii$Proxy

Enclosing class:

CfnJobTemplate

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

Specifies the amount of time each device has to finish its execution of the job.

A timer is started when the job execution status is set to IN_PROGRESS . If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT .

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.*;
 TimeoutConfigProperty timeoutConfigProperty = TimeoutConfigProperty.builder()
         .inProgressTimeoutInMinutes(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobTemplate.TimeoutConfigProperty.Builder	builder()
Number	getInProgressTimeoutInMinutes()	Specifies the amount of time, in minutes, this device has to finish execution of this job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInProgressTimeoutInMinutes

@Stability(Stable)
@NotNull
Number getInProgressTimeoutInMinutes()

Specifies the amount of time, in minutes, this device has to finish execution of this job.

The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

See Also:

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

builder

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

Returns:

a CfnJobTemplate.TimeoutConfigProperty.Builder of CfnJobTemplate.TimeoutConfigProperty