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 Summary
Modifier and TypeMethodDescriptionabortConfig
(Object abortConfig) The criteria that determine when and how a job abort takes place.build()
static CfnJobTemplate.Builder
description
(String description) A description of the job template.destinationPackageVersions
(List<String> destinationPackageVersions) The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ($package
) when the job successfully completes.The job document.documentSource
(String documentSource) An S3 link, or S3 object URL, to the job document.The ARN of the job to use as the basis for the job template.jobExecutionsRetryConfig
(IResolvable jobExecutionsRetryConfig) Allows you to create the criteria to retry a job.jobExecutionsRetryConfig
(CfnJobTemplate.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig) Allows you to create the criteria to retry a job.jobExecutionsRolloutConfig
(Object jobExecutionsRolloutConfig) Allows you to create a staged rollout of a job.jobTemplateId
(String jobTemplateId) A unique identifier for the job template.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.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.presignedUrlConfig
(Object presignedUrlConfig) Configuration for pre-signed S3 URLs.Metadata that can be used to manage the job template.timeoutConfig
(Object timeoutConfig) Specifies the amount of time each device has to finish its execution of the job.
-
Method Details
-
create
@Stability(Stable) public static CfnJobTemplate.Builder create(software.constructs.Construct scope, String id) - 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.- Returns:
- a new instance of
CfnJobTemplate.Builder
.
-
description
A description of the job template.- Parameters:
description
- A description of the job template. This parameter is required.- Returns:
this
- See Also:
-
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
- See Also:
-
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
- See Also:
-
destinationPackageVersions
@Stability(Stable) public CfnJobTemplate.Builder destinationPackageVersions(List<String> destinationPackageVersions) The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ($package
) when the job successfully completes.Note: Up to 25 package version ARNS are allowed.
- Parameters:
destinationPackageVersions
- The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ($package
) when the job successfully completes. This parameter is required.- Returns:
this
- See Also:
-
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
- See Also:
-
documentSource
An S3 link, or S3 object URL, to the job document.The link is an Amazon S3 object URL and is required if you don't specify a value for
document
.For example,
--document-source https://s3. *region-code* .amazonaws.com/example-firmware/device-firmware.1.0
For more information, see Methods for accessing a bucket .
- Parameters:
documentSource
- An S3 link, or S3 object URL, to the job document. This parameter is required.- Returns:
this
- See Also:
-
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
- See Also:
-
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
- See Also:
-
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
- See Also:
-
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
- See Also:
-
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
- See Also:
-
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
- See Also:
-
presignedUrlConfig
Configuration for pre-signed S3 URLs.- Parameters:
presignedUrlConfig
- Configuration for pre-signed S3 URLs. This parameter is required.- Returns:
this
- See Also:
-
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
- See Also:
-
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 toTIMED_OUT
.- Parameters:
timeoutConfig
- Specifies the amount of time each device has to finish its execution of the job. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnJobTemplate>
- Returns:
- a newly built instance of
CfnJobTemplate
.
-