AWS::IoT::JobTemplateRepresents a job template.
import { CfnJobTemplate } from 'aws-cdk-lib/aws-iot';Or use the module namespace:
import * as iot from 'aws-cdk-lib/aws-iot';
// iot.CfnJobTemplateConfiguration passed to the constructor as CfnJobTemplateProps.
descriptionRequiredstringA description of the job template.
jobTemplateIdRequiredstringA unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
abortConfigOptionalanyThe criteria that determine when and how a job abort takes place.
destinationPackageVersionsOptionalstring[]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.
documentOptionalstringThe job document. Required if you don't specify a value for `documentSource` .
documentSourceOptionalstringAn 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) .
jobArnOptionalstringThe ARN of the job to use as the basis for the job template.
jobExecutionsRetryConfigOptionalIResolvable | JobExecutionsRetryConfigPropertyAllows you to create the criteria to retry a job.
jobExecutionsRolloutConfigOptionalanyAllows you to create a staged rollout of a job.
maintenanceWindowsOptionalIResolvable | 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.
presignedUrlConfigOptionalanyConfiguration for pre-signed S3 URLs.
tagsOptionalCfnTag[]Metadata that can be used to manage the job template.
timeoutConfigOptionalanySpecifies 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` .
This L1 construct maps directly to the following CloudFormation resource type.
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to Newsletteraws-iotAWS::IoT::JobTemplate