Package software.amazon.awscdk.services.iot

Class CfnJobTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iot.CfnJobTemplate
All Implemented Interfaces:
IInspectable, ITaggable, IJobTemplateRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:40.078Z") @Stability(Stable) public class CfnJobTemplate extends CfnResource implements IInspectable, IJobTemplateRef, ITaggable
Represents a job template.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 Object abortConfig;
 Object jobExecutionsRolloutConfig;
 Object presignedUrlConfig;
 Object timeoutConfig;
 CfnJobTemplate cfnJobTemplate = CfnJobTemplate.Builder.create(this, "MyCfnJobTemplate")
         .description("description")
         .jobTemplateId("jobTemplateId")
         // the properties below are optional
         .abortConfig(abortConfig)
         .destinationPackageVersions(List.of("destinationPackageVersions"))
         .document("document")
         .documentSource("documentSource")
         .jobArn("jobArn")
         .jobExecutionsRetryConfig(JobExecutionsRetryConfigProperty.builder()
                 .retryCriteriaList(List.of(RetryCriteriaProperty.builder()
                         .failureType("failureType")
                         .numberOfRetries(123)
                         .build()))
                 .build())
         .jobExecutionsRolloutConfig(jobExecutionsRolloutConfig)
         .maintenanceWindows(List.of(MaintenanceWindowProperty.builder()
                 .durationInMinutes(123)
                 .startTime("startTime")
                 .build()))
         .presignedUrlConfig(presignedUrlConfig)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeoutConfig(timeoutConfig)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnJobTemplate

      protected CfnJobTemplate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnJobTemplate

      protected CfnJobTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnJobTemplate

      @Stability(Stable) public CfnJobTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnJobTemplateProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromJobTemplateArn

      @Stability(Stable) @NotNull public static IJobTemplateRef fromJobTemplateArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IJobTemplateRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromJobTemplateId

      @Stability(Stable) @NotNull public static IJobTemplateRef fromJobTemplateId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String jobTemplateId)
      Creates a new IJobTemplateRef from a jobTemplateId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      jobTemplateId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the job to use as the basis for the job template.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getJobTemplateRef

      @Stability(Stable) @NotNull public JobTemplateReference getJobTemplateRef()
      A reference to a JobTemplate resource.
      Specified by:
      getJobTemplateRef in interface IJobTemplateRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      A description of the job template.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      A description of the job template.

    • getJobTemplateId

      @Stability(Stable) @NotNull public String getJobTemplateId()
      A unique identifier for the job template.

    • setJobTemplateId

      @Stability(Stable) public void setJobTemplateId(@NotNull String value)
      A unique identifier for the job template.

    • getAbortConfig

      @Stability(Stable) @Nullable public Object getAbortConfig()
      The criteria that determine when and how a job abort takes place.

    • setAbortConfig

      @Stability(Stable) public void setAbortConfig(@Nullable Object value)
      The criteria that determine when and how a job abort takes place.

    • getDestinationPackageVersions

      @Stability(Stable) @Nullable public List<String> getDestinationPackageVersions()
      The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ( $package ) when the job successfully completes.

    • setDestinationPackageVersions

      @Stability(Stable) public void setDestinationPackageVersions(@Nullable List<String> value)
      The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ( $package ) when the job successfully completes.

    • getDocument

      @Stability(Stable) @Nullable public String getDocument()
      The job document.

    • setDocument

      @Stability(Stable) public void setDocument(@Nullable String value)
      The job document.

    • getDocumentSource

      @Stability(Stable) @Nullable public String getDocumentSource()
      An S3 link, or S3 object URL, to the job document.

    • setDocumentSource

      @Stability(Stable) public void setDocumentSource(@Nullable String value)
      An S3 link, or S3 object URL, to the job document.

    • getJobArn

      @Stability(Stable) @Nullable public String getJobArn()
      The ARN of the job to use as the basis for the job template.

    • setJobArn

      @Stability(Stable) public void setJobArn(@Nullable String value)
      The ARN of the job to use as the basis for the job template.

    • getJobExecutionsRetryConfig

      @Stability(Stable) @Nullable public Object getJobExecutionsRetryConfig()
      Allows you to create the criteria to retry a job.

      Returns union: either IResolvable or CfnJobTemplate.JobExecutionsRetryConfigProperty

    • setJobExecutionsRetryConfig

      @Stability(Stable) public void setJobExecutionsRetryConfig(@Nullable IResolvable value)
      Allows you to create the criteria to retry a job.

    • setJobExecutionsRetryConfig

      @Stability(Stable) public void setJobExecutionsRetryConfig(@Nullable CfnJobTemplate.JobExecutionsRetryConfigProperty value)
      Allows you to create the criteria to retry a job.

    • getJobExecutionsRolloutConfig

      @Stability(Stable) @Nullable public Object getJobExecutionsRolloutConfig()
      Allows you to create a staged rollout of a job.

    • setJobExecutionsRolloutConfig

      @Stability(Stable) public void setJobExecutionsRolloutConfig(@Nullable Object value)
      Allows you to create a staged rollout of a job.

    • getMaintenanceWindows

      @Stability(Stable) @Nullable public Object getMaintenanceWindows()
      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.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnJobTemplate.MaintenanceWindowProperty>

    • setMaintenanceWindows

      @Stability(Stable) public void setMaintenanceWindows(@Nullable IResolvable value)
      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.

    • setMaintenanceWindows

      @Stability(Stable) public void setMaintenanceWindows(@Nullable List<Object> value)
      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.

    • getPresignedUrlConfig

      @Stability(Stable) @Nullable public Object getPresignedUrlConfig()
      Configuration for pre-signed S3 URLs.

    • setPresignedUrlConfig

      @Stability(Stable) public void setPresignedUrlConfig(@Nullable Object value)
      Configuration for pre-signed S3 URLs.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata that can be used to manage the job template.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata that can be used to manage the job template.

    • getTimeoutConfig

      @Stability(Stable) @Nullable public Object getTimeoutConfig()
      Specifies the amount of time each device has to finish its execution of the job.

    • setTimeoutConfig

      @Stability(Stable) public void setTimeoutConfig(@Nullable Object value)
      Specifies the amount of time each device has to finish its execution of the job.