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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.860Z")
 @Stability(value=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 jobExecutionsRetryConfig;
 Object jobExecutionsRolloutConfig;
 Object presignedUrlConfig;
 Object timeoutConfig;
 CfnJobTemplateProps cfnJobTemplateProps = CfnJobTemplateProps.builder()
         .description("description")
         .jobTemplateId("jobTemplateId")
         // the properties below are optional
         .abortConfig(abortConfig)
         .document("document")
         .documentSource("documentSource")
         .jobArn("jobArn")
         .jobExecutionsRetryConfig(jobExecutionsRetryConfig)
         .jobExecutionsRolloutConfig(jobExecutionsRolloutConfig)
         .presignedUrlConfig(presignedUrlConfig)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeoutConfig(timeoutConfig)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 String	getDocument() The job document.
default String	getDocumentSource() An S3 link to the job document to use in the template.
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	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 Detail

getDescription

@Stability(value=Stable)
 @NotNull
String getDescription()

A description of the job template.

getJobTemplateId

@Stability(value=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.

getAbortConfig

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

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

getDocument

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

The job document.

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

getDocumentSource

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

getJobArn

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

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

getJobExecutionsRetryConfig

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

Allows you to create the criteria to retry a job.

getJobExecutionsRolloutConfig

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

Allows you to create a staged rollout of a job.

getPresignedUrlConfig

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

Configuration for pre-signed S3 URLs.

getTags

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

Metadata that can be used to manage the job template.

getTimeoutConfig

@Stability(value=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 .

builder

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

Returns:

a CfnJobTemplateProps.Builder of CfnJobTemplateProps