interface CfnJobProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.IoT.CfnJobProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnJobProps |
 Java | software.amazon.awscdk.services.iot.CfnJobProps |
 Python | aws_cdk.aws_iot.CfnJobProps |
 TypeScript | aws-cdk-lib » aws_iot » CfnJobProps |
Properties for defining a CfnJob.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html
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';
const cfnJobProps: iot.CfnJobProps = {
jobId: 'jobId',
targets: ['targets'],
// the properties below are optional
abortConfig: {
criteriaList: [{
action: 'action',
failureType: 'failureType',
minNumberOfExecutedThings: 123,
thresholdPercentage: 123,
}],
},
description: 'description',
destinationPackageVersions: ['destinationPackageVersions'],
document: 'document',
documentParameters: {
documentParametersKey: 'documentParameters',
},
documentSource: 'documentSource',
jobExecutionsRetryConfig: {
criteriaList: [{
failureType: 'failureType',
numberOfRetries: 123,
}],
},
jobExecutionsRolloutConfig: {
exponentialRate: {
baseRatePerMinute: 123,
incrementFactor: 123,
rateIncreaseCriteria: {
numberOfNotifiedThings: 123,
numberOfSucceededThings: 123,
},
},
maximumPerMinute: 123,
},
jobTemplateArn: 'jobTemplateArn',
presignedUrlConfig: {
expiresInSec: 123,
roleArn: 'roleArn',
},
schedulingConfig: {
endBehavior: 'endBehavior',
endTime: 'endTime',
maintenanceWindows: [{
durationInMinutes: 123,
startTime: 'startTime',
}],
startTime: 'startTime',
},
tags: [{
key: 'key',
value: 'value',
}],
targetSelection: 'targetSelection',
timeoutConfig: {
inProgressTimeoutInMinutes: 123,
},
};
Properties
| Name | Type | Description |
|---|---|---|
| job | string | A job identifier which must be unique for your AWS account. |
| targets | string[] | A list of things and thing groups to which the job should be sent. |
| abort | IResolvable | Abort | The criteria that determine when and how a job abort takes place. |
| description? | string | A short text description of the job. |
| destination | string[] | The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. |
| document? | string | The job document. |
| document | IResolvable | { [string]: string } | Parameters of an Amazon Web Services managed template that you can specify to create the job document. |
| document | string | An S3 link, or S3 object URL, to the job document. |
| job | IResolvable | Job | The configuration that determines how many retries are allowed for each failure type for a job. |
| job | IResolvable | Job | Allows you to create a staged rollout of a job. |
| job | string | The ARN of the job template used to create the job. |
| presigned | IResolvable | Presigned | Configuration for pre-signed S3 URLs. |
| scheduling | IResolvable | Scheduling | Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. |
| tags? | Cfn[] | Metadata which can be used to manage the job. |
| target | string | Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). |
| timeout | IResolvable | Timeout | Specifies the amount of time each device has to finish its execution of the job. |
jobId
Type:
string
A job identifier which must be unique for your AWS account.
We recommend using a UUID. Alpha-numeric characters, '-' and '_' are valid for use here.
targets
Type:
string[]
A list of things and thing groups to which the job should be sent.
abortConfig?
Type:
IResolvable | Abort
(optional)
The criteria that determine when and how a job abort takes place.
description?
Type:
string
(optional)
A short text description of the job.
destinationPackageVersions?
Type:
string[]
(optional)
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
document?
Type:
string
(optional)
The job document.
Required if you don't specify a value for documentSource.
documentParameters?
Type:
IResolvable | { [string]: string }
(optional)
Parameters of an Amazon Web Services managed template that you can specify to create the job document.
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.
jobExecutionsRetryConfig?
Type:
IResolvable | Job
(optional)
The configuration that determines how many retries are allowed for each failure type for a job.
jobExecutionsRolloutConfig?
Type:
IResolvable | Job
(optional)
Allows you to create a staged rollout of a job.
jobTemplateArn?
Type:
string
(optional)
The ARN of the job template used to create the job.
presignedUrlConfig?
Type:
IResolvable | Presigned
(optional)
Configuration for pre-signed S3 URLs.
schedulingConfig?
Type:
IResolvable | Scheduling
(optional)
Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.
tags?
Type:
Cfn[]
(optional)
Metadata which can be used to manage the job.
targetSelection?
Type:
string
(optional)
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT).
timeoutConfig?
Type:
IResolvable | Timeout
(optional)
Specifies the amount of time each device has to finish its execution of the job.