Package software.amazon.awscdk.services.iot

Class CfnJobTemplate.Builder

java.lang.Object
software.amazon.awscdk.services.iot.CfnJobTemplate.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnJobTemplate>
Enclosing class:
CfnJobTemplate
@Stability(Stable) public static final class CfnJobTemplate.Builder extends Object implements software.amazon.jsii.Builder<CfnJobTemplate>
A fluent builder for CfnJobTemplate.

  • Method Details

    • create

      @Stability(Stable) public static CfnJobTemplate.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnJobTemplate.Builder.

    • description

      @Stability(Stable) public CfnJobTemplate.Builder description(String description)
      A description of the job template.

      Parameters:
      description - A description of the job template. This parameter is required.
      Returns:
      this

    • jobTemplateId

      @Stability(Stable) public CfnJobTemplate.Builder jobTemplateId(String jobTemplateId)
      A unique identifier for the job template.

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

      Parameters:
      jobTemplateId - A unique identifier for the job template. This parameter is required.
      Returns:
      this

    • abortConfig

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

      Parameters:
      abortConfig - The criteria that determine when and how a job abort takes place. This parameter is required.
      Returns:
      this

    • document

      @Stability(Stable) public CfnJobTemplate.Builder document(String document)
      The job document.

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

      Parameters:
      document - The job document. This parameter is required.
      Returns:
      this

    • documentSource

      @Stability(Stable) public CfnJobTemplate.Builder documentSource(String documentSource)
      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.

      Parameters:
      documentSource - An S3 link to the job document to use in the template. This parameter is required.
      Returns:
      this

    • jobArn

      @Stability(Stable) public CfnJobTemplate.Builder jobArn(String jobArn)
      The ARN of the job to use as the basis for the job template.

      Parameters:
      jobArn - The ARN of the job to use as the basis for the job template. This parameter is required.
      Returns:
      this

    • jobExecutionsRetryConfig

      @Stability(Stable) public CfnJobTemplate.Builder jobExecutionsRetryConfig(IResolvable jobExecutionsRetryConfig)
      Allows you to create the criteria to retry a job.

      Parameters:
      jobExecutionsRetryConfig - Allows you to create the criteria to retry a job. This parameter is required.
      Returns:
      this

    • jobExecutionsRetryConfig

      @Stability(Stable) public CfnJobTemplate.Builder jobExecutionsRetryConfig(CfnJobTemplate.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig)
      Allows you to create the criteria to retry a job.

      Parameters:
      jobExecutionsRetryConfig - Allows you to create the criteria to retry a job. This parameter is required.
      Returns:
      this

    • jobExecutionsRolloutConfig

      @Stability(Stable) public CfnJobTemplate.Builder jobExecutionsRolloutConfig(Object jobExecutionsRolloutConfig)
      Allows you to create a staged rollout of a job.

      Parameters:
      jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job. This parameter is required.
      Returns:
      this

    • maintenanceWindows

      @Stability(Stable) public CfnJobTemplate.Builder maintenanceWindows(IResolvable maintenanceWindows)
      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.

      Parameters:
      maintenanceWindows - 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. This parameter is required.
      Returns:
      this

    • maintenanceWindows

      @Stability(Stable) public CfnJobTemplate.Builder maintenanceWindows(List<? extends Object> maintenanceWindows)
      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.

      Parameters:
      maintenanceWindows - 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. This parameter is required.
      Returns:
      this

    • presignedUrlConfig

      @Stability(Stable) public CfnJobTemplate.Builder presignedUrlConfig(Object presignedUrlConfig)
      Configuration for pre-signed S3 URLs.

      Parameters:
      presignedUrlConfig - Configuration for pre-signed S3 URLs. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnJobTemplate.Builder tags(List<? extends CfnTag> tags)
      Metadata that can be used to manage the job template.

      Parameters:
      tags - Metadata that can be used to manage the job template. This parameter is required.
      Returns:
      this

    • timeoutConfig

      @Stability(Stable) public CfnJobTemplate.Builder timeoutConfig(Object timeoutConfig)
      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 .

      Parameters:
      timeoutConfig - Specifies the amount of time each device has to finish its execution of the job. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnJobTemplate build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnJobTemplate>
      Returns:
      a newly built instance of CfnJobTemplate.