Package software.amazon.awscdk.services.iot

Interface CfnJobTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:00.185Z")
@Stability(Stable)
public interface CfnJobTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJobTemplateProps.Builder	A builder for CfnJobTemplateProps
static final class	CfnJobTemplateProps.Jsii$Proxy	An implementation for CfnJobTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnJobTemplateProps.Builder	builder()
default Object	getAbortConfig()	The criteria that determine when and how a job abort takes place.
String	getDescription()	A description of the job template.
default 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.
default String	getDocument()	The job document.
default String	getDocumentSource()	An S3 link, or S3 object URL, to the job document.
default String	getJobArn()	The ARN of the job to use as the basis for the job template.
default Object	getJobExecutionsRetryConfig()	Allows you to create the criteria to retry a job.
default Object	getJobExecutionsRolloutConfig()	Allows you to create a staged rollout of a job.
String	getJobTemplateId()	A unique identifier for the job template.
default 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.
default Object	getPresignedUrlConfig()	Configuration for pre-signed S3 URLs.
default List<CfnTag>	getTags()	Metadata that can be used to manage the job template.
default Object	getTimeoutConfig()	Specifies 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

@Stability(Stable)
@NotNull
String getDescription()

A description of the job template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-description

getJobTemplateId

@Stability(Stable)
@NotNull
String getJobTemplateId()

A unique identifier for the job template.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-jobtemplateid

getAbortConfig

@Stability(Stable)
@Nullable
default Object getAbortConfig()

The criteria that determine when and how a job abort takes place.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-abortconfig

getDestinationPackageVersions

@Stability(Stable)
@Nullable
default 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.

Note: Up to 25 package version ARNS are allowed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-destinationpackageversions

getDocument

@Stability(Stable)
@Nullable
default String getDocument()

The job document.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-document

getDocumentSource

@Stability(Stable)
@Nullable
default String 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.0

For more information, see Methods for accessing a bucket .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-documentsource

getJobArn

@Stability(Stable)
@Nullable
default String getJobArn()

The ARN of the job to use as the basis for the job template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-jobarn

getJobExecutionsRetryConfig

@Stability(Stable)
@Nullable
default Object getJobExecutionsRetryConfig()

Allows you to create the criteria to retry a job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-jobexecutionsretryconfig

getJobExecutionsRolloutConfig

@Stability(Stable)
@Nullable
default Object getJobExecutionsRolloutConfig()

Allows you to create a staged rollout of a job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-jobexecutionsrolloutconfig

getMaintenanceWindows

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-maintenancewindows

getPresignedUrlConfig

@Stability(Stable)
@Nullable
default Object getPresignedUrlConfig()

Configuration for pre-signed S3 URLs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-presignedurlconfig

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata that can be used to manage the job template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-tags

getTimeoutConfig

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-jobtemplate.html#cfn-iot-jobtemplate-timeoutconfig

builder

@Stability(Stable)
static CfnJobTemplateProps.Builder builder()

Returns:

a CfnJobTemplateProps.Builder of CfnJobTemplateProps