AWS Native is in preview. AWS Classic is fully supported.
aws-native.iot.JobTemplate
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
Create JobTemplate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new JobTemplate(name: string, args: JobTemplateArgs, opts?: CustomResourceOptions);
@overload
def JobTemplate(resource_name: str,
args: JobTemplateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def JobTemplate(resource_name: str,
opts: Optional[ResourceOptions] = None,
job_template_id: Optional[str] = None,
description: Optional[str] = None,
job_executions_retry_config: Optional[JobExecutionsRetryConfigPropertiesArgs] = None,
document: Optional[str] = None,
document_source: Optional[str] = None,
job_arn: Optional[str] = None,
abort_config: Optional[AbortConfigPropertiesArgs] = None,
job_executions_rollout_config: Optional[JobExecutionsRolloutConfigPropertiesArgs] = None,
destination_package_versions: Optional[Sequence[str]] = None,
maintenance_windows: Optional[Sequence[JobTemplateMaintenanceWindowArgs]] = None,
presigned_url_config: Optional[PresignedUrlConfigPropertiesArgs] = None,
tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None,
timeout_config: Optional[TimeoutConfigPropertiesArgs] = None)
func NewJobTemplate(ctx *Context, name string, args JobTemplateArgs, opts ...ResourceOption) (*JobTemplate, error)
public JobTemplate(string name, JobTemplateArgs args, CustomResourceOptions? opts = null)
public JobTemplate(String name, JobTemplateArgs args)
public JobTemplate(String name, JobTemplateArgs args, CustomResourceOptions options)
type: aws-native:iot:JobTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args JobTemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args JobTemplateArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args JobTemplateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JobTemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args JobTemplateArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
JobTemplate Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The JobTemplate resource accepts the following input properties:
- Description string
- A description of the Job Template.
- Job
Template stringId - A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
- Abort
Config Pulumi.Aws Native. Io T. Inputs. Abort Config Properties - The criteria that determine when and how a job abort takes place.
- Destination
Package List<string>Versions 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 string
- The job document. Required if you don't specify a value for documentSource.
- Document
Source string - An S3 link to the job document to use in the template. Required if you don't specify a value for document.
- Job
Arn string - Optional for copying a JobTemplate from a pre-existing Job configuration.
- Job
Executions Pulumi.Retry Config Aws Native. Io T. Inputs. Job Executions Retry Config Properties - Allows you to create the criteria to retry a job.
- Job
Executions Pulumi.Rollout Config Aws Native. Io T. Inputs. Job Executions Rollout Config Properties - Allows you to create a staged rollout of a job.
- Maintenance
Windows List<Pulumi.Aws Native. Io T. Inputs. Job Template Maintenance Window> - 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
Url Pulumi.Config Aws Native. Io T. Inputs. Presigned Url Config Properties - Configuration for pre-signed S3 URLs.
- List<Pulumi.
Aws Native. Inputs. Create Only Tag> - Metadata that can be used to manage the JobTemplate.
- Timeout
Config Pulumi.Aws Native. Io T. Inputs. Timeout Config Properties - Specifies the amount of time each device has to finish its execution of the job.
- Description string
- A description of the Job Template.
- Job
Template stringId - A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
- Abort
Config AbortConfig Properties Args - The criteria that determine when and how a job abort takes place.
- Destination
Package []stringVersions 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 string
- The job document. Required if you don't specify a value for documentSource.
- Document
Source string - An S3 link to the job document to use in the template. Required if you don't specify a value for document.
- Job
Arn string - Optional for copying a JobTemplate from a pre-existing Job configuration.
- Job
Executions JobRetry Config Executions Retry Config Properties Args - Allows you to create the criteria to retry a job.
- Job
Executions JobRollout Config Executions Rollout Config Properties Args - Allows you to create a staged rollout of a job.
- Maintenance
Windows []JobTemplate Maintenance Window Args - 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
Url PresignedConfig Url Config Properties Args - Configuration for pre-signed S3 URLs.
- Create
Only Tag Args - Metadata that can be used to manage the JobTemplate.
- Timeout
Config TimeoutConfig Properties Args - Specifies the amount of time each device has to finish its execution of the job.
- description String
- A description of the Job Template.
- job
Template StringId - A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
- abort
Config AbortConfig Properties - The criteria that determine when and how a job abort takes place.
- destination
Package List<String>Versions 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 String
- The job document. Required if you don't specify a value for documentSource.
- document
Source String - An S3 link to the job document to use in the template. Required if you don't specify a value for document.
- job
Arn String - Optional for copying a JobTemplate from a pre-existing Job configuration.
- job
Executions JobRetry Config Executions Retry Config Properties - Allows you to create the criteria to retry a job.
- job
Executions JobRollout Config Executions Rollout Config Properties - Allows you to create a staged rollout of a job.
- maintenance
Windows List<JobTemplate Maintenance Window> - 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
Url PresignedConfig Url Config Properties - Configuration for pre-signed S3 URLs.
- List<Create
Only Tag> - Metadata that can be used to manage the JobTemplate.
- timeout
Config TimeoutConfig Properties - Specifies the amount of time each device has to finish its execution of the job.
- description string
- A description of the Job Template.
- job
Template stringId - A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
- abort
Config AbortConfig Properties - The criteria that determine when and how a job abort takes place.
- destination
Package string[]Versions 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 string
- The job document. Required if you don't specify a value for documentSource.
- document
Source string - An S3 link to the job document to use in the template. Required if you don't specify a value for document.
- job
Arn string - Optional for copying a JobTemplate from a pre-existing Job configuration.
- job
Executions JobRetry Config Executions Retry Config Properties - Allows you to create the criteria to retry a job.
- job
Executions JobRollout Config Executions Rollout Config Properties - Allows you to create a staged rollout of a job.
- maintenance
Windows JobTemplate Maintenance Window[] - 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
Url PresignedConfig Url Config Properties - Configuration for pre-signed S3 URLs.
- Create
Only Tag[] - Metadata that can be used to manage the JobTemplate.
- timeout
Config TimeoutConfig Properties - Specifies the amount of time each device has to finish its execution of the job.
- description str
- A description of the Job Template.
- job_
template_ strid - A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
- abort_
config AbortConfig Properties Args - The criteria that determine when and how a job abort takes place.
- destination_
package_ Sequence[str]versions 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 str
- The job document. Required if you don't specify a value for documentSource.
- document_
source str - An S3 link to the job document to use in the template. Required if you don't specify a value for document.
- job_
arn str - Optional for copying a JobTemplate from a pre-existing Job configuration.
- job_
executions_ Jobretry_ config Executions Retry Config Properties Args - Allows you to create the criteria to retry a job.
- job_
executions_ Jobrollout_ config Executions Rollout Config Properties Args - Allows you to create a staged rollout of a job.
- maintenance_
windows Sequence[JobTemplate Maintenance Window Args] - 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_
url_ Presignedconfig Url Config Properties Args - Configuration for pre-signed S3 URLs.
- Sequence[Create
Only Tag Args] - Metadata that can be used to manage the JobTemplate.
- timeout_
config TimeoutConfig Properties Args - Specifies the amount of time each device has to finish its execution of the job.
- description String
- A description of the Job Template.
- job
Template StringId - A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
- abort
Config Property Map - The criteria that determine when and how a job abort takes place.
- destination
Package List<String>Versions 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 String
- The job document. Required if you don't specify a value for documentSource.
- document
Source String - An S3 link to the job document to use in the template. Required if you don't specify a value for document.
- job
Arn String - Optional for copying a JobTemplate from a pre-existing Job configuration.
- job
Executions Property MapRetry Config - Allows you to create the criteria to retry a job.
- job
Executions Property MapRollout Config - Allows you to create a staged rollout of a job.
- maintenance
Windows List<Property Map> - 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
Url Property MapConfig - Configuration for pre-signed S3 URLs.
- List<Property Map>
- Metadata that can be used to manage the JobTemplate.
- timeout
Config Property Map - Specifies the amount of time each device has to finish its execution of the job.
Outputs
All input properties are implicitly available as output properties. Additionally, the JobTemplate resource produces the following output properties:
Supporting Types
AbortConfigProperties, AbortConfigPropertiesArgs
- Criteria
List List<Pulumi.Aws Native. Io T. Inputs. Job Template Abort Criteria> - The list of criteria that determine when and how to abort the job.
- Criteria
List []JobTemplate Abort Criteria - The list of criteria that determine when and how to abort the job.
- criteria
List List<JobTemplate Abort Criteria> - The list of criteria that determine when and how to abort the job.
- criteria
List JobTemplate Abort Criteria[] - The list of criteria that determine when and how to abort the job.
- criteria_
list Sequence[JobTemplate Abort Criteria] - The list of criteria that determine when and how to abort the job.
- criteria
List List<Property Map> - The list of criteria that determine when and how to abort the job.
CreateOnlyTag, CreateOnlyTagArgs
JobExecutionsRetryConfigProperties, JobExecutionsRetryConfigPropertiesArgs
- Retry
Criteria List<Pulumi.List Aws Native. Io T. Inputs. Job Template Retry Criteria> - The list of criteria that determines how many retries are allowed for each failure type for a job.
- Retry
Criteria []JobList Template Retry Criteria - The list of criteria that determines how many retries are allowed for each failure type for a job.
- retry
Criteria List<JobList Template Retry Criteria> - The list of criteria that determines how many retries are allowed for each failure type for a job.
- retry
Criteria JobList Template Retry Criteria[] - The list of criteria that determines how many retries are allowed for each failure type for a job.
- retry_
criteria_ Sequence[Joblist Template Retry Criteria] - The list of criteria that determines how many retries are allowed for each failure type for a job.
- retry
Criteria List<Property Map>List - The list of criteria that determines how many retries are allowed for each failure type for a job.
JobExecutionsRolloutConfigProperties, JobExecutionsRolloutConfigPropertiesArgs
- Exponential
Rollout Pulumi.Rate Aws Native. Io T. Inputs. Job Template Exponential Rollout Rate - The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
- Maximum
Per intMinute - The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
- Exponential
Rollout JobRate Template Exponential Rollout Rate - The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
- Maximum
Per intMinute - The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
- exponential
Rollout JobRate Template Exponential Rollout Rate - The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
- maximum
Per IntegerMinute - The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
- exponential
Rollout JobRate Template Exponential Rollout Rate - The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
- maximum
Per numberMinute - The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
- exponential_
rollout_ Jobrate Template Exponential Rollout Rate - The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
- maximum_
per_ intminute - The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
- exponential
Rollout Property MapRate - The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
- maximum
Per NumberMinute - The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
JobTemplateAbortCriteria, JobTemplateAbortCriteriaArgs
- Action
Pulumi.
Aws Native. Io T. Job Template Action - The type of job action to take to initiate the job abort.
- Failure
Type Pulumi.Aws Native. Io T. Job Template Failure Type - The type of job execution failures that can initiate a job abort.
- Min
Number intOf Executed Things - The minimum number of things which must receive job execution notifications before the job can be aborted.
- Threshold
Percentage double - The minimum percentage of job execution failures that must occur to initiate the job abort.
- Action
Job
Template Action - The type of job action to take to initiate the job abort.
- Failure
Type JobTemplate Failure Type - The type of job execution failures that can initiate a job abort.
- Min
Number intOf Executed Things - The minimum number of things which must receive job execution notifications before the job can be aborted.
- Threshold
Percentage float64 - The minimum percentage of job execution failures that must occur to initiate the job abort.
- action
Job
Template Action - The type of job action to take to initiate the job abort.
- failure
Type JobTemplate Failure Type - The type of job execution failures that can initiate a job abort.
- min
Number IntegerOf Executed Things - The minimum number of things which must receive job execution notifications before the job can be aborted.
- threshold
Percentage Double - The minimum percentage of job execution failures that must occur to initiate the job abort.
- action
Job
Template Action - The type of job action to take to initiate the job abort.
- failure
Type JobTemplate Failure Type - The type of job execution failures that can initiate a job abort.
- min
Number numberOf Executed Things - The minimum number of things which must receive job execution notifications before the job can be aborted.
- threshold
Percentage number - The minimum percentage of job execution failures that must occur to initiate the job abort.
- action
Job
Template Action - The type of job action to take to initiate the job abort.
- failure_
type JobTemplate Failure Type - The type of job execution failures that can initiate a job abort.
- min_
number_ intof_ executed_ things - The minimum number of things which must receive job execution notifications before the job can be aborted.
- threshold_
percentage float - The minimum percentage of job execution failures that must occur to initiate the job abort.
- action "CANCEL"
- The type of job action to take to initiate the job abort.
- failure
Type "FAILED" | "REJECTED" | "TIMED_OUT" | "ALL" - The type of job execution failures that can initiate a job abort.
- min
Number NumberOf Executed Things - The minimum number of things which must receive job execution notifications before the job can be aborted.
- threshold
Percentage Number - The minimum percentage of job execution failures that must occur to initiate the job abort.
JobTemplateAction, JobTemplateActionArgs
- Cancel
- CANCEL
- Job
Template Action Cancel - CANCEL
- Cancel
- CANCEL
- Cancel
- CANCEL
- CANCEL
- CANCEL
- "CANCEL"
- CANCEL
JobTemplateExponentialRolloutRate, JobTemplateExponentialRolloutRateArgs
- Base
Rate intPer Minute - The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
- Increment
Factor double - The exponential factor to increase the rate of rollout for a job.
- Rate
Increase Pulumi.Criteria Aws Native. Io T. Inputs. Job Template Rate Increase Criteria - The criteria to initiate the increase in rate of rollout for a job.
- Base
Rate intPer Minute - The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
- Increment
Factor float64 - The exponential factor to increase the rate of rollout for a job.
- Rate
Increase JobCriteria Template Rate Increase Criteria - The criteria to initiate the increase in rate of rollout for a job.
- base
Rate IntegerPer Minute - The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
- increment
Factor Double - The exponential factor to increase the rate of rollout for a job.
- rate
Increase JobCriteria Template Rate Increase Criteria - The criteria to initiate the increase in rate of rollout for a job.
- base
Rate numberPer Minute - The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
- increment
Factor number - The exponential factor to increase the rate of rollout for a job.
- rate
Increase JobCriteria Template Rate Increase Criteria - The criteria to initiate the increase in rate of rollout for a job.
- base_
rate_ intper_ minute - The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
- increment_
factor float - The exponential factor to increase the rate of rollout for a job.
- rate_
increase_ Jobcriteria Template Rate Increase Criteria - The criteria to initiate the increase in rate of rollout for a job.
- base
Rate NumberPer Minute - The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
- increment
Factor Number - The exponential factor to increase the rate of rollout for a job.
- rate
Increase Property MapCriteria - The criteria to initiate the increase in rate of rollout for a job.
JobTemplateFailureType, JobTemplateFailureTypeArgs
- Failed
- FAILED
- Rejected
- REJECTED
- Timed
Out - TIMED_OUT
- All
- ALL
- Job
Template Failure Type Failed - FAILED
- Job
Template Failure Type Rejected - REJECTED
- Job
Template Failure Type Timed Out - TIMED_OUT
- Job
Template Failure Type All - ALL
- Failed
- FAILED
- Rejected
- REJECTED
- Timed
Out - TIMED_OUT
- All
- ALL
- Failed
- FAILED
- Rejected
- REJECTED
- Timed
Out - TIMED_OUT
- All
- ALL
- FAILED
- FAILED
- REJECTED
- REJECTED
- TIMED_OUT
- TIMED_OUT
- ALL
- ALL
- "FAILED"
- FAILED
- "REJECTED"
- REJECTED
- "TIMED_OUT"
- TIMED_OUT
- "ALL"
- ALL
JobTemplateJobRetryFailureType, JobTemplateJobRetryFailureTypeArgs
- Failed
- FAILED
- Timed
Out - TIMED_OUT
- All
- ALL
- Job
Template Job Retry Failure Type Failed - FAILED
- Job
Template Job Retry Failure Type Timed Out - TIMED_OUT
- Job
Template Job Retry Failure Type All - ALL
- Failed
- FAILED
- Timed
Out - TIMED_OUT
- All
- ALL
- Failed
- FAILED
- Timed
Out - TIMED_OUT
- All
- ALL
- FAILED
- FAILED
- TIMED_OUT
- TIMED_OUT
- ALL
- ALL
- "FAILED"
- FAILED
- "TIMED_OUT"
- TIMED_OUT
- "ALL"
- ALL
JobTemplateMaintenanceWindow, JobTemplateMaintenanceWindowArgs
- Duration
In intMinutes - Displays the duration of the next maintenance window.
- Start
Time string - Displays the start time of the next maintenance window.
- Duration
In intMinutes - Displays the duration of the next maintenance window.
- Start
Time string - Displays the start time of the next maintenance window.
- duration
In IntegerMinutes - Displays the duration of the next maintenance window.
- start
Time String - Displays the start time of the next maintenance window.
- duration
In numberMinutes - Displays the duration of the next maintenance window.
- start
Time string - Displays the start time of the next maintenance window.
- duration_
in_ intminutes - Displays the duration of the next maintenance window.
- start_
time str - Displays the start time of the next maintenance window.
- duration
In NumberMinutes - Displays the duration of the next maintenance window.
- start
Time String - Displays the start time of the next maintenance window.
JobTemplateRateIncreaseCriteria, JobTemplateRateIncreaseCriteriaArgs
- Number
Of intNotified Things - The threshold for number of notified things that will initiate the increase in rate of rollout.
- Number
Of intSucceeded Things - The threshold for number of succeeded things that will initiate the increase in rate of rollout.
- Number
Of intNotified Things - The threshold for number of notified things that will initiate the increase in rate of rollout.
- Number
Of intSucceeded Things - The threshold for number of succeeded things that will initiate the increase in rate of rollout.
- number
Of IntegerNotified Things - The threshold for number of notified things that will initiate the increase in rate of rollout.
- number
Of IntegerSucceeded Things - The threshold for number of succeeded things that will initiate the increase in rate of rollout.
- number
Of numberNotified Things - The threshold for number of notified things that will initiate the increase in rate of rollout.
- number
Of numberSucceeded Things - The threshold for number of succeeded things that will initiate the increase in rate of rollout.
- number_
of_ intnotified_ things - The threshold for number of notified things that will initiate the increase in rate of rollout.
- number_
of_ intsucceeded_ things - The threshold for number of succeeded things that will initiate the increase in rate of rollout.
- number
Of NumberNotified Things - The threshold for number of notified things that will initiate the increase in rate of rollout.
- number
Of NumberSucceeded Things - The threshold for number of succeeded things that will initiate the increase in rate of rollout.
JobTemplateRetryCriteria, JobTemplateRetryCriteriaArgs
- Failure
Type Pulumi.Aws Native. Io T. Job Template Job Retry Failure Type - The type of job execution failures that can initiate a job retry.
- Number
Of intRetries - The number of retries allowed for a failure type for the job.
- Failure
Type JobTemplate Job Retry Failure Type - The type of job execution failures that can initiate a job retry.
- Number
Of intRetries - The number of retries allowed for a failure type for the job.
- failure
Type JobTemplate Job Retry Failure Type - The type of job execution failures that can initiate a job retry.
- number
Of IntegerRetries - The number of retries allowed for a failure type for the job.
- failure
Type JobTemplate Job Retry Failure Type - The type of job execution failures that can initiate a job retry.
- number
Of numberRetries - The number of retries allowed for a failure type for the job.
- failure_
type JobTemplate Job Retry Failure Type - The type of job execution failures that can initiate a job retry.
- number_
of_ intretries - The number of retries allowed for a failure type for the job.
- failure
Type "FAILED" | "TIMED_OUT" | "ALL" - The type of job execution failures that can initiate a job retry.
- number
Of NumberRetries - The number of retries allowed for a failure type for the job.
PresignedUrlConfigProperties, PresignedUrlConfigPropertiesArgs
- Role
Arn string The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the AWS IoT Core developer guide .
- Expires
In intSec - How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
- Role
Arn string The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the AWS IoT Core developer guide .
- Expires
In intSec - How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
- role
Arn String The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the AWS IoT Core developer guide .
- expires
In IntegerSec - How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
- role
Arn string The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the AWS IoT Core developer guide .
- expires
In numberSec - How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
- role_
arn str The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the AWS IoT Core developer guide .
- expires_
in_ intsec - How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
- role
Arn String The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the AWS IoT Core developer guide .
- expires
In NumberSec - How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
TimeoutConfigProperties, TimeoutConfigPropertiesArgs
- In
Progress intTimeout In Minutes - Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal
TIMED_OUT
status.
- In
Progress intTimeout In Minutes - Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal
TIMED_OUT
status.
- in
Progress IntegerTimeout In Minutes - Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal
TIMED_OUT
status.
- in
Progress numberTimeout In Minutes - Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal
TIMED_OUT
status.
- in_
progress_ inttimeout_ in_ minutes - Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal
TIMED_OUT
status.
- in
Progress NumberTimeout In Minutes - Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal
TIMED_OUT
status.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.