Package software.amazon.awscdk.services.iot

Class CfnJobTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iot.CfnJobTemplate
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.562Z") @Stability(Stable) public class CfnJobTemplate extends CfnResource implements IInspectable
A CloudFormation AWS::IoT::JobTemplate.

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)
         .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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnJobTemplateProps props)
      Create a new AWS::IoT::JobTemplate.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata that can be used to manage the job template.

    • getAbortConfig

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

    • setAbortConfig

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

    • 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.

    • getJobExecutionsRolloutConfig

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

    • setJobExecutionsRolloutConfig

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

    • getJobTemplateId

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

      We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

    • setJobTemplateId

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

      We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

    • getPresignedUrlConfig

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

    • setPresignedUrlConfig

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

    • getTimeoutConfig

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

      A timer is started when the job execution status is set to IN_PROGRESS . If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT .

    • setTimeoutConfig

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

      A timer is started when the job execution status is set to IN_PROGRESS . If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT .

    • getDocument

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

      Required if you don't specify a value for documentSource .

    • setDocument

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

      Required if you don't specify a value for documentSource .

    • getDocumentSource

      @Stability(Stable) @Nullable public String getDocumentSource()
      An S3 link to the job document to use in the template.

      Required if you don't specify a value for document .

      If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

      The placeholder link is of the following form:

      ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/ *bucket* / *key* }

      where bucket is your bucket name and key is the object in the bucket to which you are linking.

    • setDocumentSource

      @Stability(Stable) public void setDocumentSource(@Nullable String value)
      An S3 link to the job document to use in the template.

      Required if you don't specify a value for document .

      If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

      The placeholder link is of the following form:

      ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/ *bucket* / *key* }

      where bucket is your bucket name and key is the object in the bucket to which you are linking.

    • 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.

    • 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.

    • 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.

    • 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.