Package software.amazon.awscdk.services.iot

Class CfnJobTemplateProps.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnJobTemplateProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobTemplateProps>

Enclosing interface:

CfnJobTemplateProps

@Stability(Stable)
public static final class CfnJobTemplateProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnJobTemplateProps>

A builder for CfnJobTemplateProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnJobTemplateProps.Builder	abortConfig(Object abortConfig)	Sets the value of CfnJobTemplateProps.getAbortConfig()
CfnJobTemplateProps	build()	Builds the configured instance.
CfnJobTemplateProps.Builder	description(String description)	Sets the value of CfnJobTemplateProps.getDescription()
CfnJobTemplateProps.Builder	destinationPackageVersions(List<String> destinationPackageVersions)	Sets the value of CfnJobTemplateProps.getDestinationPackageVersions()
CfnJobTemplateProps.Builder	document(String document)	Sets the value of CfnJobTemplateProps.getDocument()
CfnJobTemplateProps.Builder	documentSource(String documentSource)	Sets the value of CfnJobTemplateProps.getDocumentSource()
CfnJobTemplateProps.Builder	jobArn(String jobArn)	Sets the value of CfnJobTemplateProps.getJobArn()
CfnJobTemplateProps.Builder	jobExecutionsRetryConfig(IResolvable jobExecutionsRetryConfig)	Sets the value of CfnJobTemplateProps.getJobExecutionsRetryConfig()
CfnJobTemplateProps.Builder	jobExecutionsRetryConfig(CfnJobTemplate.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig)	Sets the value of CfnJobTemplateProps.getJobExecutionsRetryConfig()
CfnJobTemplateProps.Builder	jobExecutionsRolloutConfig(Object jobExecutionsRolloutConfig)	Sets the value of CfnJobTemplateProps.getJobExecutionsRolloutConfig()
CfnJobTemplateProps.Builder	jobTemplateId(String jobTemplateId)	Sets the value of CfnJobTemplateProps.getJobTemplateId()
CfnJobTemplateProps.Builder	maintenanceWindows(List<? extends Object> maintenanceWindows)	Sets the value of CfnJobTemplateProps.getMaintenanceWindows()
CfnJobTemplateProps.Builder	maintenanceWindows(IResolvable maintenanceWindows)	Sets the value of CfnJobTemplateProps.getMaintenanceWindows()
CfnJobTemplateProps.Builder	presignedUrlConfig(Object presignedUrlConfig)	Sets the value of CfnJobTemplateProps.getPresignedUrlConfig()
CfnJobTemplateProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnJobTemplateProps.getTags()
CfnJobTemplateProps.Builder	timeoutConfig(Object timeoutConfig)	Sets the value of CfnJobTemplateProps.getTimeoutConfig()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

description

@Stability(Stable)
public CfnJobTemplateProps.Builder description(String description)

Sets the value of CfnJobTemplateProps.getDescription()

Parameters:

description - A description of the job template. This parameter is required.

Returns:

this

jobTemplateId

@Stability(Stable)
public CfnJobTemplateProps.Builder jobTemplateId(String jobTemplateId)

Sets the value of CfnJobTemplateProps.getJobTemplateId()

Parameters:

jobTemplateId - A unique identifier for the job template. This parameter is required. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

Returns:

this

abortConfig

@Stability(Stable)
public CfnJobTemplateProps.Builder abortConfig(Object abortConfig)

Sets the value of CfnJobTemplateProps.getAbortConfig()

Parameters:

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

Returns:

this

destinationPackageVersions

@Stability(Stable)
public CfnJobTemplateProps.Builder destinationPackageVersions(List<String> destinationPackageVersions)

Sets the value of CfnJobTemplateProps.getDestinationPackageVersions()

Parameters:

destinationPackageVersions - 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.

Returns:

this

document

@Stability(Stable)
public CfnJobTemplateProps.Builder document(String document)

Sets the value of CfnJobTemplateProps.getDocument()

Parameters:

document - The job document. Required if you don't specify a value for documentSource .

Returns:

this

documentSource

@Stability(Stable)
public CfnJobTemplateProps.Builder documentSource(String documentSource)

Sets the value of CfnJobTemplateProps.getDocumentSource()

Parameters:

documentSource - 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 .

Returns:

this

jobArn

@Stability(Stable)
public CfnJobTemplateProps.Builder jobArn(String jobArn)

Sets the value of CfnJobTemplateProps.getJobArn()

Parameters:

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

Returns:

this

jobExecutionsRetryConfig

@Stability(Stable)
public CfnJobTemplateProps.Builder jobExecutionsRetryConfig(IResolvable jobExecutionsRetryConfig)

Sets the value of CfnJobTemplateProps.getJobExecutionsRetryConfig()

Parameters:

jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.

Returns:

this

jobExecutionsRetryConfig

@Stability(Stable)
public CfnJobTemplateProps.Builder jobExecutionsRetryConfig(CfnJobTemplate.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig)

Sets the value of CfnJobTemplateProps.getJobExecutionsRetryConfig()

Parameters:

jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.

Returns:

this

jobExecutionsRolloutConfig

@Stability(Stable)
public CfnJobTemplateProps.Builder jobExecutionsRolloutConfig(Object jobExecutionsRolloutConfig)

Sets the value of CfnJobTemplateProps.getJobExecutionsRolloutConfig()

Parameters:

jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job.

Returns:

this

maintenanceWindows

@Stability(Stable)
public CfnJobTemplateProps.Builder maintenanceWindows(IResolvable maintenanceWindows)

Sets the value of CfnJobTemplateProps.getMaintenanceWindows()

Parameters:

maintenanceWindows - 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:

this

maintenanceWindows

@Stability(Stable)
public CfnJobTemplateProps.Builder maintenanceWindows(List<? extends Object> maintenanceWindows)

Sets the value of CfnJobTemplateProps.getMaintenanceWindows()

Parameters:

maintenanceWindows - 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:

this

presignedUrlConfig

@Stability(Stable)
public CfnJobTemplateProps.Builder presignedUrlConfig(Object presignedUrlConfig)

Sets the value of CfnJobTemplateProps.getPresignedUrlConfig()

Parameters:

presignedUrlConfig - Configuration for pre-signed S3 URLs.

Returns:

this

tags

@Stability(Stable)
public CfnJobTemplateProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnJobTemplateProps.getTags()

Parameters:

tags - Metadata that can be used to manage the job template.

Returns:

this

timeoutConfig

@Stability(Stable)
public CfnJobTemplateProps.Builder timeoutConfig(Object timeoutConfig)

Sets the value of CfnJobTemplateProps.getTimeoutConfig()

Parameters:

timeoutConfig - 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 .

Returns:

this

build

@Stability(Stable)
public CfnJobTemplateProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnJobTemplateProps>

Returns:

a new instance of CfnJobTemplateProps

Throws:

NullPointerException - if any required attribute was not provided