aws-cdk-lib.aws_iot.CfnJobTemplateProps

interface CfnJobTemplateProps

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnJobTemplateProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnJobTemplateProps
Javasoftware.amazon.awscdk.services.iot.CfnJobTemplateProps
Pythonaws_cdk.aws_iot.CfnJobTemplateProps
TypeScript aws-cdk-lib » 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 { aws_iot as iot } from 'aws-cdk-lib';

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

NameTypeDescription
descriptionstringA description of the job template.
jobTemplateIdstringA unique identifier for the job template.
abortConfig?anyThe criteria that determine when and how a job abort takes place.
document?stringThe job document.
documentSource?stringAn S3 link, or S3 object URL, to the job document.
jobArn?stringThe ARN of the job to use as the basis for the job template.
jobExecutionsRetryConfig?IResolvable | JobExecutionsRetryConfigPropertyAllows you to create the criteria to retry a job.
jobExecutionsRolloutConfig?anyAllows 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?anyConfiguration for pre-signed S3 URLs.
tags?CfnTag[]Metadata that can be used to manage the job template.
timeoutConfig?anySpecifies 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, 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 .


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 .