AWS Native v0.63.0, May 25 23
AWS Native v0.63.0, May 25 23
aws-native.iot.JobTemplate
Explore with Pulumi AI
Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
Create JobTemplate Resource
new JobTemplate(name: string, args: JobTemplateArgs, opts?: CustomResourceOptions);
@overload
def JobTemplate(resource_name: str,
opts: Optional[ResourceOptions] = None,
abort_config: Optional[AbortConfigPropertiesArgs] = None,
description: Optional[str] = None,
document: Optional[str] = None,
document_source: Optional[str] = None,
job_arn: Optional[str] = None,
job_executions_retry_config: Optional[JobExecutionsRetryConfigPropertiesArgs] = None,
job_executions_rollout_config: Optional[JobExecutionsRolloutConfigPropertiesArgs] = None,
job_template_id: Optional[str] = None,
maintenance_windows: Optional[Sequence[JobTemplateMaintenanceWindowArgs]] = None,
presigned_url_config: Optional[PresignedUrlConfigPropertiesArgs] = None,
tags: Optional[Sequence[JobTemplateTagArgs]] = None,
timeout_config: Optional[TimeoutConfigPropertiesArgs] = None)
@overload
def JobTemplate(resource_name: str,
args: JobTemplateArgs,
opts: Optional[ResourceOptions] = 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.
- 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 - Abort
Config Pulumi.Aws Native. Io T. Inputs. Abort Config Properties Args The criteria that determine when and how a job abort takes place.
- 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 Args - Job
Executions Pulumi.Rollout Config Aws Native. Io T. Inputs. Job Executions Rollout Config Properties Args Allows you to create a staged rollout of a job.
- Maintenance
Windows List<Pulumi.Aws Native. Io T. Inputs. Job Template Maintenance Window Args> - Presigned
Url Pulumi.Config Aws Native. Io T. Inputs. Presigned Url Config Properties Args Configuration for pre-signed S3 URLs.
- List<Pulumi.
Aws Native. Io T. Inputs. Job Template Tag Args> Metadata that can be used to manage the JobTemplate.
- Timeout
Config Pulumi.Aws Native. Io T. Inputs. Timeout Config 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 - Abort
Config AbortConfig Properties Args The criteria that determine when and how a job abort takes place.
- 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 - 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 - Presigned
Url PresignedConfig Url Config Properties Args Configuration for pre-signed S3 URLs.
- []Job
Template 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 - abort
Config AbortConfig Properties Args The criteria that determine when and how a job abort takes place.
- 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 - job
Executions JobRollout Config Executions Rollout Config Properties Args Allows you to create a staged rollout of a job.
- maintenance
Windows List<JobTemplate Maintenance Window Args> - presigned
Url PresignedConfig Url Config Properties Args Configuration for pre-signed S3 URLs.
- List<Job
Template 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 - abort
Config AbortConfig Properties Args The criteria that determine when and how a job abort takes place.
- 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 - 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[] - presigned
Url PresignedConfig Url Config Properties Args Configuration for pre-signed S3 URLs.
- Job
Template 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 str
A description of the Job Template.
- job_
template_ strid - abort_
config AbortConfig Properties Args The criteria that determine when and how a job abort takes place.
- 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 - 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] - presigned_
url_ Presignedconfig Url Config Properties Args Configuration for pre-signed S3 URLs.
- Sequence[Job
Template 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 - abort
Config Property Map The criteria that determine when and how a job abort takes place.
- 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 - job
Executions Property MapRollout Config Allows you to create a staged rollout of a job.
- maintenance
Windows List<Property Map> - 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
JobExecutionsRetryConfigProperties
JobExecutionsRolloutConfigProperties
- 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
- 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
- Cancel
- CANCEL
- Job
Template Action Cancel - CANCEL
- Cancel
- CANCEL
- Cancel
- CANCEL
- CANCEL
- CANCEL
- "CANCEL"
- CANCEL
JobTemplateExponentialRolloutRate
- 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
- 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
- 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
- Duration
In intMinutes - Start
Time string
- Duration
In intMinutes - Start
Time string
- duration
In IntegerMinutes - start
Time String
- duration
In numberMinutes - start
Time string
- duration_
in_ intminutes - start_
time str
- duration
In NumberMinutes - start
Time String
JobTemplateRateIncreaseCriteria
- number
Of IntegerNotified Things - number
Of IntegerSucceeded Things
- number
Of numberNotified Things - number
Of numberSucceeded Things
- number
Of NumberNotified Things - number
Of NumberSucceeded Things
JobTemplateRetryCriteria
JobTemplateTag
PresignedUrlConfigProperties
- Role
Arn string - Expires
In intSec
- Role
Arn string - Expires
In intSec
- role
Arn String - expires
In IntegerSec
- role
Arn string - expires
In numberSec
- role_
arn str - expires_
in_ intsec
- role
Arn String - expires
In NumberSec
TimeoutConfigProperties
- in
Progress IntegerTimeout In Minutes
- in
Progress numberTimeout In Minutes
- in
Progress NumberTimeout In Minutes
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0