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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.966Z")
 @Stability(value=Stable)
public class CfnJobTemplate
extends CfnResource
implements IInspectable

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

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;
 CfnJobTemplate cfnJobTemplate = CfnJobTemplate.Builder.create(this, "MyCfnJobTemplate")
         .description("description")
         .jobTemplateId("jobTemplateId")
         // the properties below are optional
         .abortConfig(abortConfig)
         .document("document")
         .documentSource("documentSource")
         .jobArn("jobArn")
         .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() `AWS::IoT::JobTemplate.AbortConfig`.
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::IoT::JobTemplate.Description`.
String	getDocument() `AWS::IoT::JobTemplate.Document`.
String	getDocumentSource() `AWS::IoT::JobTemplate.DocumentSource`.
String	getJobArn() `AWS::IoT::JobTemplate.JobArn`.
Object	getJobExecutionsRolloutConfig() `AWS::IoT::JobTemplate.JobExecutionsRolloutConfig`.
String	getJobTemplateId() `AWS::IoT::JobTemplate.JobTemplateId`.
Object	getPresignedUrlConfig() `AWS::IoT::JobTemplate.PresignedUrlConfig`.
TagManager	getTags() `AWS::IoT::JobTemplate.Tags`.
Object	getTimeoutConfig() `AWS::IoT::JobTemplate.TimeoutConfig`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAbortConfig(Object value) `AWS::IoT::JobTemplate.AbortConfig`.
void	setDescription(String value) `AWS::IoT::JobTemplate.Description`.
void	setDocument(String value) `AWS::IoT::JobTemplate.Document`.
void	setDocumentSource(String value) `AWS::IoT::JobTemplate.DocumentSource`.
void	setJobArn(String value) `AWS::IoT::JobTemplate.JobArn`.
void	setJobExecutionsRolloutConfig(Object value) `AWS::IoT::JobTemplate.JobExecutionsRolloutConfig`.
void	setJobTemplateId(String value) `AWS::IoT::JobTemplate.JobTemplateId`.
void	setPresignedUrlConfig(Object value) `AWS::IoT::JobTemplate.PresignedUrlConfig`.
void	setTimeoutConfig(Object value) `AWS::IoT::JobTemplate.TimeoutConfig`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, 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.

getAbortConfig

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

`AWS::IoT::JobTemplate.AbortConfig`.

setAbortConfig

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

`AWS::IoT::JobTemplate.AbortConfig`.

getAttrArn

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDescription

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

`AWS::IoT::JobTemplate.Description`.

setDescription

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

`AWS::IoT::JobTemplate.Description`.

getDocument

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

`AWS::IoT::JobTemplate.Document`.

setDocument

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

`AWS::IoT::JobTemplate.Document`.

getDocumentSource

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

`AWS::IoT::JobTemplate.DocumentSource`.

setDocumentSource

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

`AWS::IoT::JobTemplate.DocumentSource`.

getJobArn

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

`AWS::IoT::JobTemplate.JobArn`.

setJobArn

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

`AWS::IoT::JobTemplate.JobArn`.

getJobExecutionsRolloutConfig

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

`AWS::IoT::JobTemplate.JobExecutionsRolloutConfig`.

setJobExecutionsRolloutConfig

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

`AWS::IoT::JobTemplate.JobExecutionsRolloutConfig`.

getJobTemplateId

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

`AWS::IoT::JobTemplate.JobTemplateId`.

setJobTemplateId

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

`AWS::IoT::JobTemplate.JobTemplateId`.

getPresignedUrlConfig

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

`AWS::IoT::JobTemplate.PresignedUrlConfig`.

setPresignedUrlConfig

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

`AWS::IoT::JobTemplate.PresignedUrlConfig`.

getTags

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

`AWS::IoT::JobTemplate.Tags`.

getTimeoutConfig

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

`AWS::IoT::JobTemplate.TimeoutConfig`.

setTimeoutConfig

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

`AWS::IoT::JobTemplate.TimeoutConfig`.