AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoT::JobTemplate

CfnJobTemplate

Represents a job template.

Import

import { CfnJobTemplate } from 'aws-cdk-lib/aws-iot';

Or use the module namespace:

import * as iot from 'aws-cdk-lib/aws-iot';
// iot.CfnJobTemplate

Properties

Configuration passed to the constructor as CfnJobTemplateProps.

descriptionRequired
string

A description of the job template.

jobTemplateIdRequired
string

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

abortConfigOptional
any

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

destinationPackageVersionsOptional
string[]

The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ( `$package` ) when the job successfully completes. *Note:* Up to 25 package version ARNS are allowed.

documentOptional
string

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

documentSourceOptional
string

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for `document` . For example, `--document-source https://s3. *region-code* .amazonaws.com/example-firmware/device-firmware.1.0` For more information, see [Methods for accessing a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html) .

jobArnOptional
string

The ARN of the job to use as the basis for the job template.

jobExecutionsRetryConfigOptional
IResolvable | JobExecutionsRetryConfigProperty

Allows you to create the criteria to retry a job.

jobExecutionsRolloutConfigOptional
any

Allows you to create a staged rollout of a job.

maintenanceWindowsOptional
IResolvable | IResolvable | MaintenanceWindowProperty[]

An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.

presignedUrlConfigOptional
any

Configuration for pre-signed S3 URLs.

tagsOptional
CfnTag[]

Metadata that can be used to manage the job template.

timeoutConfigOptional
any

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter