software.amazon.awscdk.services.iot

Class CfnJobTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnJobTemplate

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.859Z")
 @Stability(value=Stable)
public class CfnJobTemplate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoT::JobTemplate`.

Represents a job template.

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;
 CfnJobTemplate cfnJobTemplate = CfnJobTemplate.Builder.create(this, "MyCfnJobTemplate")
         .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	Class and Description
static class	CfnJobTemplate.Builder A fluent builder for CfnJobTemplate.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnJobTemplate(software.constructs.Construct scope, String id, CfnJobTemplateProps props) Create a new `AWS::IoT::JobTemplate`.
protected	CfnJobTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnJobTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAbortConfig() The criteria that determine when and how a job abort takes place.
String	getAttrArn() The ARN of the job to use as the basis for the job template.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the job template.
String	getDocument() The job document.
String	getDocumentSource() An S3 link to the job document to use in the template.
String	getJobArn() The ARN of the job to use as the basis for the job template.
Object	getJobExecutionsRetryConfig() Allows you to create the criteria to retry a job.
Object	getJobExecutionsRolloutConfig() Allows you to create a staged rollout of a job.
String	getJobTemplateId() A unique identifier for the job template.
Object	getPresignedUrlConfig() Configuration for pre-signed S3 URLs.
TagManager	getTags() Metadata that can be used to manage the job template.
Object	getTimeoutConfig() Specifies the amount of time each device has to finish its execution of the job.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAbortConfig(Object value) The criteria that determine when and how a job abort takes place.
void	setDescription(String value) A description of the job template.
void	setDocument(String value) The job document.
void	setDocumentSource(String value) An S3 link to the job document to use in the template.
void	setJobArn(String value) The ARN of the job to use as the basis for the job template.
void	setJobExecutionsRetryConfig(Object value) Allows you to create the criteria to retry a job.
void	setJobExecutionsRolloutConfig(Object value) Allows you to create a staged rollout of a job.
void	setJobTemplateId(String value) A unique identifier for the job template.
void	setPresignedUrlConfig(Object value) Configuration for pre-signed S3 URLs.
void	setTimeoutConfig(Object value) Specifies the amount of time each device has to finish its execution of the job.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnJobTemplate

protected CfnJobTemplate(software.amazon.jsii.JsiiObjectRef objRef)

CfnJobTemplate

protected CfnJobTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnJobTemplate

@Stability(value=Stable)
public CfnJobTemplate(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnJobTemplateProps props)

Create a new `AWS::IoT::JobTemplate`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Metadata that can be used to manage the job template.

getAbortConfig

@Stability(value=Stable)
 @NotNull
public Object getAbortConfig()

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

setAbortConfig

@Stability(value=Stable)
public void setAbortConfig(@NotNull
                                                    Object value)

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

getDescription

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

A description of the job template.

setDescription

@Stability(value=Stable)
public void setDescription(@NotNull
                                                    String value)

A description of the job template.

getJobExecutionsRetryConfig

@Stability(value=Stable)
 @NotNull
public Object getJobExecutionsRetryConfig()

Allows you to create the criteria to retry a job.

setJobExecutionsRetryConfig

@Stability(value=Stable)
public void setJobExecutionsRetryConfig(@NotNull
                                                                 Object value)

Allows you to create the criteria to retry a job.

getJobExecutionsRolloutConfig

@Stability(value=Stable)
 @NotNull
public Object getJobExecutionsRolloutConfig()

Allows you to create a staged rollout of a job.

setJobExecutionsRolloutConfig

@Stability(value=Stable)
public void setJobExecutionsRolloutConfig(@NotNull
                                                                   Object value)

Allows you to create a staged rollout of a job.

getJobTemplateId

@Stability(value=Stable)
 @NotNull
public String getJobTemplateId()

A unique identifier for the job template.

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

setJobTemplateId

@Stability(value=Stable)
public void setJobTemplateId(@NotNull
                                                      String value)

A unique identifier for the job template.

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

getPresignedUrlConfig

@Stability(value=Stable)
 @NotNull
public Object getPresignedUrlConfig()

Configuration for pre-signed S3 URLs.

setPresignedUrlConfig

@Stability(value=Stable)
public void setPresignedUrlConfig(@NotNull
                                                           Object value)

Configuration for pre-signed S3 URLs.

getTimeoutConfig

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

setTimeoutConfig

@Stability(value=Stable)
public void setTimeoutConfig(@NotNull
                                                      Object value)

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 .

getDocument

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

The job document.

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

setDocument

@Stability(value=Stable)
public void setDocument(@Nullable
                                                 String value)

The job document.

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

getDocumentSource

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

setDocumentSource

@Stability(value=Stable)
public void setDocumentSource(@Nullable
                                                       String value)

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
public String getJobArn()

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

setJobArn

@Stability(value=Stable)
public void setJobArn(@Nullable
                                               String value)

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