Package software.amazon.awscdk.cfnpropertymixins.services.iot

Class CfnJobTemplateMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iot.CfnJobTemplateMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobTemplateMixinProps>

Enclosing interface:

CfnJobTemplateMixinProps

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

A builder for CfnJobTemplateMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

abortConfig

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

Sets the value of CfnJobTemplateMixinProps.getAbortConfig()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnJobTemplateMixinProps.getDescription()

Parameters:

description - A description of the job template.

Returns:

this

destinationPackageVersions

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

Sets the value of CfnJobTemplateMixinProps.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 CfnJobTemplateMixinProps.Builder document(String document)

Sets the value of CfnJobTemplateMixinProps.getDocument()

Parameters:

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

Returns:

this

documentSource

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

Sets the value of CfnJobTemplateMixinProps.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 CfnJobTemplateMixinProps.Builder jobArn(String jobArn)

Sets the value of CfnJobTemplateMixinProps.getJobArn()

Parameters:

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

Returns:

this

jobExecutionsRetryConfig

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

Sets the value of CfnJobTemplateMixinProps.getJobExecutionsRetryConfig()

Parameters:

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

Returns:

this

jobExecutionsRetryConfig

@Stability(Stable)
public CfnJobTemplateMixinProps.Builder jobExecutionsRetryConfig(CfnJobTemplatePropsMixin.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig)

Sets the value of CfnJobTemplateMixinProps.getJobExecutionsRetryConfig()

Parameters:

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

Returns:

this

jobExecutionsRolloutConfig

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

Sets the value of CfnJobTemplateMixinProps.getJobExecutionsRolloutConfig()

Parameters:

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

Returns:

this

jobTemplateId

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

Sets the value of CfnJobTemplateMixinProps.getJobTemplateId()

Parameters:

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

Returns:

this

maintenanceWindows

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

Sets the value of CfnJobTemplateMixinProps.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 CfnJobTemplateMixinProps.Builder maintenanceWindows(List<? extends Object> maintenanceWindows)

Sets the value of CfnJobTemplateMixinProps.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 CfnJobTemplateMixinProps.Builder presignedUrlConfig(Object presignedUrlConfig)

Sets the value of CfnJobTemplateMixinProps.getPresignedUrlConfig()

Parameters:

presignedUrlConfig - Configuration for pre-signed S3 URLs.

Returns:

this

tags

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

Sets the value of CfnJobTemplateMixinProps.getTags()

Parameters:

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

Returns:

this

timeoutConfig

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

Sets the value of CfnJobTemplateMixinProps.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 CfnJobTemplateMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnJobTemplateMixinProps

Throws:

NullPointerException - if any required attribute was not provided