Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-iot-jobtemplate.json
Parent schema serverless-framework-configuration
Type: object

Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iot.git

Properties

JobTemplateId string | Aws_CF_FunctionString required
Description string | Aws_CF_FunctionString required

A description of the Job Template.

JobArn string | Aws_CF_FunctionString

Optional for copying a JobTemplate from a pre-existing Job configuration.

Document string | Aws_CF_FunctionString

The job document. Required if you don't specify a value for documentSource.

DocumentSource string | Aws_CF_FunctionString

An S3 link to the job document to use in the template. Required if you don't specify a value for document.

TimeoutConfig object

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

1 nested properties
InProgressTimeoutInMinutes integer required

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

min=1max=10080
JobExecutionsRolloutConfig object

Allows you to create a staged rollout of a job.

2 nested properties
ExponentialRolloutRate object

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

3 nested properties
BaseRatePerMinute integer required
min=1
IncrementFactor number required
min=1max=5
RateIncreaseCriteria object required
2 nested properties
NumberOfNotifiedThings integer
min=1
NumberOfSucceededThings integer
min=1
MaximumPerMinute integer
min=1
AbortConfig object

The criteria that determine when and how a job abort takes place.

1 nested properties
CriteriaList AbortCriteria[] required
minItems=1
PresignedUrlConfig object

Configuration for pre-signed S3 URLs.

2 nested properties
RoleArn string | Aws_CF_FunctionString required

The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.

ExpiresInSec integer

How number (in seconds) pre-signed URLs are valid.

min=60max=3600
JobExecutionsRetryConfig object
1 nested properties
RetryCriteriaList RetryCriteria[]
minItems=1maxItems=2
MaintenanceWindows MaintenanceWindow[]
Tags Tag[]

Metadata that can be used to manage the JobTemplate.

maxItems=50uniqueItems=true

Definitions

ExponentialRolloutRate object

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

BaseRatePerMinute integer required
min=1
IncrementFactor number required
min=1max=5
RateIncreaseCriteria object required
2 nested properties
NumberOfNotifiedThings integer
min=1
NumberOfSucceededThings integer
min=1
BaseRatePerMinute integer
IncrementFactor number
RateIncreaseCriteria object
NumberOfNotifiedThings integer
min=1
NumberOfSucceededThings integer
min=1
NumberOfNotifiedThings integer
NumberOfSucceededThings integer
MaximumPerMinute integer
AbortCriteria object

The criteria that determine when and how a job abort takes place.

Action string | Aws_CF_FunctionString required
FailureType string | Aws_CF_FunctionString required
MinNumberOfExecutedThings integer required
min=1
ThresholdPercentage number required
max=100
Action string | Aws_CF_FunctionString
FailureType string | Aws_CF_FunctionString
MinNumberOfExecutedThings integer
ThresholdPercentage number
InProgressTimeoutInMinutes integer

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

RoleArn string | Aws_CF_FunctionString

The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.

ExpiresInSec integer

How number (in seconds) pre-signed URLs are valid.

RetryCriteria object

Specifies how many times a failure type should be retried.

NumberOfRetries integer
min=0max=10
FailureType string | Aws_CF_FunctionString
JobRetryFailureType string | Aws_CF_FunctionString
MaintenanceWindow object

Specifies a start time and duration for a scheduled Job.

StartTime string | Aws_CF_FunctionString
DurationInMinutes integer
min=1max=1430
Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The tag's key.

Value string | Aws_CF_FunctionString required

The tag's value.