interface CfnJobTemplateMixinProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.IoT.Mixins.CfnJobTemplateMixinProps |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiot/mixins#CfnJobTemplateMixinProps |
 Java | software.amazon.awscdk.mixins.preview.services.iot.mixins.CfnJobTemplateMixinProps |
 Python | aws_cdk.mixins_preview.aws_iot.mixins.CfnJobTemplateMixinProps |
 TypeScript | @aws-cdk/mixins-preview » aws_iot » mixins » CfnJobTemplateMixinProps |
Properties for CfnJobTemplatePropsMixin.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iot_mixins } from '@aws-cdk/mixins-preview/aws-iot';
declare const abortConfig: any;
declare const jobExecutionsRolloutConfig: any;
declare const presignedUrlConfig: any;
declare const timeoutConfig: any;
const cfnJobTemplateMixinProps: iot_mixins.CfnJobTemplateMixinProps = {
abortConfig: abortConfig,
description: 'description',
destinationPackageVersions: ['destinationPackageVersions'],
document: 'document',
documentSource: 'documentSource',
jobArn: 'jobArn',
jobExecutionsRetryConfig: {
retryCriteriaList: [{
failureType: 'failureType',
numberOfRetries: 123,
}],
},
jobExecutionsRolloutConfig: jobExecutionsRolloutConfig,
jobTemplateId: 'jobTemplateId',
maintenanceWindows: [{
durationInMinutes: 123,
startTime: 'startTime',
}],
presignedUrlConfig: presignedUrlConfig,
tags: [{
key: 'key',
value: 'value',
}],
timeoutConfig: timeoutConfig,
};
Properties
| Name | Type | Description |
|---|---|---|
| abort | any | The criteria that determine when and how a job abort takes place. |
| description? | string | A description of the job template. |
| destination | string[] | The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ( $package ) when the job successfully completes. |
| document? | string | The job document. |
| document | string | An S3 link, or S3 object URL, to the job document. |
| job | string | The ARN of the job to use as the basis for the job template. |
| job | IResolvable | Job | Allows you to create the criteria to retry a job. |
| job | any | Allows you to create a staged rollout of a job. |
| job | string | A unique identifier for the job template. |
| maintenance | IResolvable | (IResolvable | Maintenance)[] | 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. |
| presigned | any | Configuration for pre-signed S3 URLs. |
| tags? | Cfn[] | Metadata that can be used to manage the job template. |
| timeout | any | Specifies the amount of time each device has to finish its execution of the job. |
abortConfig?
Type:
any
(optional)
The criteria that determine when and how a job abort takes place.
description?
Type:
string
(optional)
A description of the job template.
destinationPackageVersions?
Type:
string[]
(optional)
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.
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 | Job
(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.
jobTemplateId?
Type:
string
(optional)
A unique identifier for the job template.
We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
maintenanceWindows?
Type:
IResolvable | (IResolvable | Maintenance)[]
(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:
Cfn[]
(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 .