interface CfnJobTemplateProps

Language	Type name
.NET	Amazon.CDK.AWS.IoT.CfnJobTemplateProps
Java	software.amazon.awscdk.services.iot.CfnJobTemplateProps
Python	aws_cdk.aws_iot.CfnJobTemplateProps
TypeScript	@aws-cdk/aws-iot » CfnJobTemplateProps

Properties for defining a CfnJobTemplate.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iot from '@aws-cdk/aws-iot';

declare const abortConfig: any;
declare const jobExecutionsRolloutConfig: any;
declare const presignedUrlConfig: any;
declare const timeoutConfig: any;
const cfnJobTemplateProps: iot.CfnJobTemplateProps = {
  description: 'description',
  jobTemplateId: 'jobTemplateId',

  // the properties below are optional
  abortConfig: abortConfig,
  document: 'document',
  documentSource: 'documentSource',
  jobArn: 'jobArn',
  jobExecutionsRetryConfig: {
    retryCriteriaList: [{
      failureType: 'failureType',
      numberOfRetries: 123,
    }],
  },
  jobExecutionsRolloutConfig: jobExecutionsRolloutConfig,
  maintenanceWindows: [{
    durationInMinutes: 123,
    startTime: 'startTime',
  }],
  presignedUrlConfig: presignedUrlConfig,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeoutConfig: timeoutConfig,
};

Properties

Name	Type	Description
description	string	A description of the job template.
jobTemplateId	string	A unique identifier for the job template.
abortConfig?	any	The criteria that determine when and how a job abort takes place.
document?	string	The job document.
documentSource?	string	An S3 link to the job document to use in the template.
jobArn?	string	The ARN of the job to use as the basis for the job template.
jobExecutionsRetryConfig?	IResolvable | JobExecutionsRetryConfigProperty	Allows you to create the criteria to retry a job.
jobExecutionsRolloutConfig?	any	Allows you to create a staged rollout of a job.
maintenanceWindows?	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.
presignedUrlConfig?	any	Configuration for pre-signed S3 URLs.
tags?	CfnTag[]	Metadata that can be used to manage the job template.
timeoutConfig?	any	Specifies the amount of time each device has to finish its execution of the job.

---

description

Type: string

A description of the job template.

---

jobTemplateId

Type: string

A unique identifier for the job template.

We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

---

abortConfig?

Type: any (optional)

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

---

document?

Type: string (optional)

The job document.

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

---

documentSource?

Type: string (optional)

An S3 link to the job document to use in the template.

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

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/ *bucket* / *key* }

where bucket is your bucket name and key is the object in the bucket to which you are linking.

---

jobArn?

Type: string (optional)

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

---

jobExecutionsRetryConfig?

Type: IResolvable | JobExecutionsRetryConfigProperty (optional)

Allows you to create the criteria to retry a job.

---

jobExecutionsRolloutConfig?

Type: any (optional)

Allows you to create a staged rollout of a job.

---

maintenanceWindows?

Type: IResolvable | IResolvable | MaintenanceWindowProperty[] (optional)

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.

---

presignedUrlConfig?

Type: any (optional)

Configuration for pre-signed S3 URLs.

---

tags?

Type: CfnTag[] (optional)

Metadata that can be used to manage the job template.

---

timeoutConfig?

Type: any (optional)

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 .