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.
JobTemplateId string
AbortConfig Pulumi.AwsNative.IoT.Inputs.AbortConfigPropertiesArgs: 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.
DocumentSource string: An S3 link to the job document to use in the template. Required if you don't specify a value for document.
JobArn string: Optional for copying a JobTemplate from a pre-existing Job configuration.
JobExecutionsRetryConfig Pulumi.AwsNative.IoT.Inputs.JobExecutionsRetryConfigPropertiesArgs
JobExecutionsRolloutConfig Pulumi.AwsNative.IoT.Inputs.JobExecutionsRolloutConfigPropertiesArgs: Allows you to create a staged rollout of a job.
MaintenanceWindows List<Pulumi.AwsNative.IoT.Inputs.JobTemplateMaintenanceWindowArgs>
PresignedUrlConfig Pulumi.AwsNative.IoT.Inputs.PresignedUrlConfigPropertiesArgs: Configuration for pre-signed S3 URLs.
Tags List<Pulumi.AwsNative.IoT.Inputs.JobTemplateTagArgs>: Metadata that can be used to manage the JobTemplate.
TimeoutConfig Pulumi.AwsNative.IoT.Inputs.TimeoutConfigPropertiesArgs: Specifies the amount of time each device has to finish its execution of the job.

Description string: A description of the Job Template.
JobTemplateId string
AbortConfig AbortConfigPropertiesArgs: 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.
DocumentSource string: An S3 link to the job document to use in the template. Required if you don't specify a value for document.
JobArn string: Optional for copying a JobTemplate from a pre-existing Job configuration.
JobExecutionsRetryConfig JobExecutionsRetryConfigPropertiesArgs
JobExecutionsRolloutConfig JobExecutionsRolloutConfigPropertiesArgs: Allows you to create a staged rollout of a job.
MaintenanceWindows []JobTemplateMaintenanceWindowArgs
PresignedUrlConfig PresignedUrlConfigPropertiesArgs: Configuration for pre-signed S3 URLs.
Tags []JobTemplateTagArgs: Metadata that can be used to manage the JobTemplate.
TimeoutConfig TimeoutConfigPropertiesArgs: Specifies the amount of time each device has to finish its execution of the job.

description String: A description of the Job Template.
jobTemplateId String
abortConfig AbortConfigPropertiesArgs: 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.
documentSource String: An S3 link to the job document to use in the template. Required if you don't specify a value for document.
jobArn String: Optional for copying a JobTemplate from a pre-existing Job configuration.
jobExecutionsRetryConfig JobExecutionsRetryConfigPropertiesArgs
jobExecutionsRolloutConfig JobExecutionsRolloutConfigPropertiesArgs: Allows you to create a staged rollout of a job.
maintenanceWindows List<JobTemplateMaintenanceWindowArgs>
presignedUrlConfig PresignedUrlConfigPropertiesArgs: Configuration for pre-signed S3 URLs.
tags List<JobTemplateTagArgs>: Metadata that can be used to manage the JobTemplate.
timeoutConfig TimeoutConfigPropertiesArgs: Specifies the amount of time each device has to finish its execution of the job.

description string: A description of the Job Template.
jobTemplateId string
abortConfig AbortConfigPropertiesArgs: 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.
documentSource string: An S3 link to the job document to use in the template. Required if you don't specify a value for document.
jobArn string: Optional for copying a JobTemplate from a pre-existing Job configuration.
jobExecutionsRetryConfig JobExecutionsRetryConfigPropertiesArgs
jobExecutionsRolloutConfig JobExecutionsRolloutConfigPropertiesArgs: Allows you to create a staged rollout of a job.
maintenanceWindows JobTemplateMaintenanceWindowArgs[]
presignedUrlConfig PresignedUrlConfigPropertiesArgs: Configuration for pre-signed S3 URLs.
tags JobTemplateTagArgs[]: Metadata that can be used to manage the JobTemplate.
timeoutConfig TimeoutConfigPropertiesArgs: 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_id str
abort_config AbortConfigPropertiesArgs: 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_retry_config JobExecutionsRetryConfigPropertiesArgs
job_executions_rollout_config JobExecutionsRolloutConfigPropertiesArgs: Allows you to create a staged rollout of a job.
maintenance_windows Sequence[JobTemplateMaintenanceWindowArgs]
presigned_url_config PresignedUrlConfigPropertiesArgs: Configuration for pre-signed S3 URLs.
tags Sequence[JobTemplateTagArgs]: Metadata that can be used to manage the JobTemplate.
timeout_config TimeoutConfigPropertiesArgs: Specifies the amount of time each device has to finish its execution of the job.

description String: A description of the Job Template.
jobTemplateId String
abortConfig 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.
documentSource String: An S3 link to the job document to use in the template. Required if you don't specify a value for document.
jobArn String: Optional for copying a JobTemplate from a pre-existing Job configuration.
jobExecutionsRetryConfig Property Map
jobExecutionsRolloutConfig Property Map: Allows you to create a staged rollout of a job.
maintenanceWindows List<Property Map>
presignedUrlConfig Property Map: Configuration for pre-signed S3 URLs.
tags List<Property Map>: Metadata that can be used to manage the JobTemplate.
timeoutConfig 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:

Arn string
Id string: The provider-assigned unique ID for this managed resource.

Arn string
Id string: The provider-assigned unique ID for this managed resource.

arn String
id String: The provider-assigned unique ID for this managed resource.

arn string
id string: The provider-assigned unique ID for this managed resource.

arn str
id str: The provider-assigned unique ID for this managed resource.

arn String
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

AbortConfigProperties

CriteriaList List<Pulumi.AwsNative.IoT.Inputs.JobTemplateAbortCriteria>

CriteriaList []JobTemplateAbortCriteria

criteriaList List<JobTemplateAbortCriteria>

criteriaList JobTemplateAbortCriteria[]

criteria_list Sequence[JobTemplateAbortCriteria]

criteriaList List<Property Map>

JobExecutionsRetryConfigProperties

RetryCriteriaList List<Pulumi.AwsNative.IoT.Inputs.JobTemplateRetryCriteria>

RetryCriteriaList []JobTemplateRetryCriteria

retryCriteriaList List<JobTemplateRetryCriteria>

retryCriteriaList JobTemplateRetryCriteria[]

retry_criteria_list Sequence[JobTemplateRetryCriteria]

retryCriteriaList List<Property Map>

JobExecutionsRolloutConfigProperties

ExponentialRolloutRate Pulumi.AwsNative.IoT.Inputs.JobTemplateExponentialRolloutRate: The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
MaximumPerMinute int: The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

ExponentialRolloutRate JobTemplateExponentialRolloutRate: The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
MaximumPerMinute int: The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

exponentialRolloutRate JobTemplateExponentialRolloutRate: The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
maximumPerMinute Integer: The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

exponentialRolloutRate JobTemplateExponentialRolloutRate: The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
maximumPerMinute number: 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_rate JobTemplateExponentialRolloutRate: The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
maximum_per_minute int: The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

exponentialRolloutRate Property Map: The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
maximumPerMinute Number: 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.AwsNative.IoT.JobTemplateAction: The type of job action to take to initiate the job abort.
FailureType Pulumi.AwsNative.IoT.JobTemplateFailureType: The type of job execution failures that can initiate a job abort.
MinNumberOfExecutedThings int: The minimum number of things which must receive job execution notifications before the job can be aborted.
ThresholdPercentage double: The minimum percentage of job execution failures that must occur to initiate the job abort.

Action JobTemplateAction: The type of job action to take to initiate the job abort.
FailureType JobTemplateFailureType: The type of job execution failures that can initiate a job abort.
MinNumberOfExecutedThings int: The minimum number of things which must receive job execution notifications before the job can be aborted.
ThresholdPercentage float64: The minimum percentage of job execution failures that must occur to initiate the job abort.

action JobTemplateAction: The type of job action to take to initiate the job abort.
failureType JobTemplateFailureType: The type of job execution failures that can initiate a job abort.
minNumberOfExecutedThings Integer: The minimum number of things which must receive job execution notifications before the job can be aborted.
thresholdPercentage Double: The minimum percentage of job execution failures that must occur to initiate the job abort.

action JobTemplateAction: The type of job action to take to initiate the job abort.
failureType JobTemplateFailureType: The type of job execution failures that can initiate a job abort.
minNumberOfExecutedThings number: The minimum number of things which must receive job execution notifications before the job can be aborted.
thresholdPercentage number: The minimum percentage of job execution failures that must occur to initiate the job abort.

action JobTemplateAction: The type of job action to take to initiate the job abort.
failure_type JobTemplateFailureType: The type of job execution failures that can initiate a job abort.
min_number_of_executed_things int: 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.
failureType "FAILED" | "REJECTED" | "TIMED_OUT" | "ALL": The type of job execution failures that can initiate a job abort.
minNumberOfExecutedThings Number: The minimum number of things which must receive job execution notifications before the job can be aborted.
thresholdPercentage Number: The minimum percentage of job execution failures that must occur to initiate the job abort.

JobTemplateAction

Cancel: CANCEL

JobTemplateActionCancel: CANCEL

Cancel: CANCEL

Cancel: CANCEL

CANCEL: CANCEL

"CANCEL": CANCEL

JobTemplateExponentialRolloutRate

BaseRatePerMinute int: 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.
IncrementFactor double: The exponential factor to increase the rate of rollout for a job.
RateIncreaseCriteria Pulumi.AwsNative.IoT.Inputs.JobTemplateRateIncreaseCriteria: The criteria to initiate the increase in rate of rollout for a job.

BaseRatePerMinute int: 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.
IncrementFactor float64: The exponential factor to increase the rate of rollout for a job.
RateIncreaseCriteria JobTemplateRateIncreaseCriteria: The criteria to initiate the increase in rate of rollout for a job.

baseRatePerMinute Integer: 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.
incrementFactor Double: The exponential factor to increase the rate of rollout for a job.
rateIncreaseCriteria JobTemplateRateIncreaseCriteria: The criteria to initiate the increase in rate of rollout for a job.

baseRatePerMinute number: 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.
incrementFactor number: The exponential factor to increase the rate of rollout for a job.
rateIncreaseCriteria JobTemplateRateIncreaseCriteria: The criteria to initiate the increase in rate of rollout for a job.

base_rate_per_minute int: 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_criteria JobTemplateRateIncreaseCriteria: The criteria to initiate the increase in rate of rollout for a job.

baseRatePerMinute Number: 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.
incrementFactor Number: The exponential factor to increase the rate of rollout for a job.
rateIncreaseCriteria Property Map: The criteria to initiate the increase in rate of rollout for a job.