Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. iot
  5. JobTemplate

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.JobTemplate

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const jobTemplateResource = new aws_native.iot.JobTemplate("jobTemplateResource", {
    jobTemplateId: "string",
    description: "string",
    jobExecutionsRetryConfig: {
        retryCriteriaList: [{
            failureType: aws_native.iot.JobTemplateJobRetryFailureType.Failed,
            numberOfRetries: 0,
        }],
    },
    document: "string",
    documentSource: "string",
    jobArn: "string",
    abortConfig: {
        criteriaList: [{
            action: aws_native.iot.JobTemplateAction.Cancel,
            failureType: aws_native.iot.JobTemplateFailureType.Failed,
            minNumberOfExecutedThings: 0,
            thresholdPercentage: 0,
        }],
    },
    jobExecutionsRolloutConfig: {
        exponentialRolloutRate: {
            baseRatePerMinute: 0,
            incrementFactor: 0,
            rateIncreaseCriteria: {
                numberOfNotifiedThings: 0,
                numberOfSucceededThings: 0,
            },
        },
        maximumPerMinute: 0,
    },
    destinationPackageVersions: ["string"],
    maintenanceWindows: [{
        durationInMinutes: 0,
        startTime: "string",
    }],
    presignedUrlConfig: {
        roleArn: "string",
        expiresInSec: 0,
    },
    tags: [{
        key: "string",
        value: "string",
    }],
    timeoutConfig: {
        inProgressTimeoutInMinutes: 0,
    },
});

    Coming soon!

    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.AbortConfigProperties
    The criteria that determine when and how a job abort takes place.
    DestinationPackageVersions List<string>
    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.JobExecutionsRetryConfigProperties
    JobExecutionsRolloutConfig Pulumi.AwsNative.IoT.Inputs.JobExecutionsRolloutConfigProperties
    Allows you to create a staged rollout of a job.
    MaintenanceWindows List<Pulumi.AwsNative.IoT.Inputs.JobTemplateMaintenanceWindow>
    PresignedUrlConfig Pulumi.AwsNative.IoT.Inputs.PresignedUrlConfigProperties
    Configuration for pre-signed S3 URLs.
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    Metadata that can be used to manage the JobTemplate.
    TimeoutConfig Pulumi.AwsNative.IoT.Inputs.TimeoutConfigProperties
    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.
    DestinationPackageVersions []string
    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 CreateOnlyTagArgs
    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 AbortConfigProperties
    The criteria that determine when and how a job abort takes place.
    destinationPackageVersions List<String>
    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 JobExecutionsRetryConfigProperties
    jobExecutionsRolloutConfig JobExecutionsRolloutConfigProperties
    Allows you to create a staged rollout of a job.
    maintenanceWindows List<JobTemplateMaintenanceWindow>
    presignedUrlConfig PresignedUrlConfigProperties
    Configuration for pre-signed S3 URLs.
    tags List<CreateOnlyTag>
    Metadata that can be used to manage the JobTemplate.
    timeoutConfig TimeoutConfigProperties
    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 AbortConfigProperties
    The criteria that determine when and how a job abort takes place.
    destinationPackageVersions string[]
    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 JobExecutionsRetryConfigProperties
    jobExecutionsRolloutConfig JobExecutionsRolloutConfigProperties
    Allows you to create a staged rollout of a job.
    maintenanceWindows JobTemplateMaintenanceWindow[]
    presignedUrlConfig PresignedUrlConfigProperties
    Configuration for pre-signed S3 URLs.
    tags CreateOnlyTag[]
    Metadata that can be used to manage the JobTemplate.
    timeoutConfig TimeoutConfigProperties
    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.
    destination_package_versions Sequence[str]
    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[CreateOnlyTagArgs]
    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.
    destinationPackageVersions List<String>
    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, AbortConfigPropertiesArgs

    CreateOnlyTag, CreateOnlyTagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    JobExecutionsRetryConfigProperties, JobExecutionsRetryConfigPropertiesArgs

    JobExecutionsRolloutConfigProperties, JobExecutionsRolloutConfigPropertiesArgs

    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, JobTemplateAbortCriteriaArgs

    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, JobTemplateActionArgs

    Cancel
    CANCEL
    JobTemplateActionCancel
    CANCEL
    Cancel
    CANCEL
    Cancel
    CANCEL
    CANCEL
    CANCEL
    "CANCEL"
    CANCEL

    JobTemplateExponentialRolloutRate, JobTemplateExponentialRolloutRateArgs

    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.

    JobTemplateFailureType, JobTemplateFailureTypeArgs

    Failed
    FAILED
    Rejected
    REJECTED
    TimedOut
    TIMED_OUT
    All
    ALL
    JobTemplateFailureTypeFailed
    FAILED
    JobTemplateFailureTypeRejected
    REJECTED
    JobTemplateFailureTypeTimedOut
    TIMED_OUT
    JobTemplateFailureTypeAll
    ALL
    Failed
    FAILED
    Rejected
    REJECTED
    TimedOut
    TIMED_OUT
    All
    ALL
    Failed
    FAILED
    Rejected
    REJECTED
    TimedOut
    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
    TimedOut
    TIMED_OUT
    All
    ALL
    JobTemplateJobRetryFailureTypeFailed
    FAILED
    JobTemplateJobRetryFailureTypeTimedOut
    TIMED_OUT
    JobTemplateJobRetryFailureTypeAll
    ALL
    Failed
    FAILED
    TimedOut
    TIMED_OUT
    All
    ALL
    Failed
    FAILED
    TimedOut
    TIMED_OUT
    All
    ALL
    FAILED
    FAILED
    TIMED_OUT
    TIMED_OUT
    ALL
    ALL
    "FAILED"
    FAILED
    "TIMED_OUT"
    TIMED_OUT
    "ALL"
    ALL

    JobTemplateMaintenanceWindow, JobTemplateMaintenanceWindowArgs

    JobTemplateRateIncreaseCriteria, JobTemplateRateIncreaseCriteriaArgs

    JobTemplateRetryCriteria, JobTemplateRetryCriteriaArgs

    PresignedUrlConfigProperties, PresignedUrlConfigPropertiesArgs

    roleArn String
    expiresInSec Integer
    roleArn string
    expiresInSec number
    roleArn String
    expiresInSec Number

    TimeoutConfigProperties, TimeoutConfigPropertiesArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native