Interface CfnJobTemplateProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnJobTemplateProps.Jsii$Proxy
CfnJobTemplate.
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;
CfnJobTemplateProps cfnJobTemplateProps = CfnJobTemplateProps.builder()
.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnJobTemplatePropsstatic final classAn implementation forCfnJobTemplateProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnJobTemplateProps.Builderbuilder()default ObjectThe criteria that determine when and how a job abort takes place.A description of the job template.The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ($package) when the job successfully completes.default StringThe job document.default StringAn S3 link, or S3 object URL, to the job document.default StringThe ARN of the job to use as the basis for the job template.default ObjectAllows you to create the criteria to retry a job.default ObjectAllows you to create a staged rollout of a job.A unique identifier for the job template.default ObjectAn 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.default ObjectConfiguration for pre-signed S3 URLs.getTags()Metadata that can be used to manage the job template.default ObjectSpecifies the amount of time each device has to finish its execution of the job.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDescription
A description of the job template.- See Also:
-
getJobTemplateId
A unique identifier for the job template.We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
- See Also:
-
getAbortConfig
The criteria that determine when and how a job abort takes place.- See Also:
-
getDestinationPackageVersions
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.
- See Also:
-
getDocument
The job document.Required if you don't specify a value for
documentSource.- See Also:
-
getDocumentSource
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.0For more information, see Methods for accessing a bucket .
- See Also:
-
getJobArn
The ARN of the job to use as the basis for the job template.- See Also:
-
getJobExecutionsRetryConfig
Allows you to create the criteria to retry a job.Returns union: either
IResolvableorCfnJobTemplate.JobExecutionsRetryConfigProperty- See Also:
-
getJobExecutionsRolloutConfig
Allows you to create a staged rollout of a job.- See Also:
-
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
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnJobTemplate.MaintenanceWindowProperty>- See Also:
-
getPresignedUrlConfig
Configuration for pre-signed S3 URLs.- See Also:
-
getTags
Metadata that can be used to manage the job template.- See Also:
-
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 toTIMED_OUT.- See Also:
-
builder
- Returns:
- a
CfnJobTemplateProps.BuilderofCfnJobTemplateProps
-