Package software.amazon.awscdk.services.iot

Class CfnJobProps.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnJobProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobProps>

Enclosing interface:

CfnJobProps

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

A builder for CfnJobProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnJobProps.Builder	abortConfig(IResolvable abortConfig)	Sets the value of CfnJobProps.getAbortConfig()
CfnJobProps.Builder	abortConfig(CfnJob.AbortConfigProperty abortConfig)	Sets the value of CfnJobProps.getAbortConfig()
CfnJobProps	build()	Builds the configured instance.
CfnJobProps.Builder	description(String description)	Sets the value of CfnJobProps.getDescription()
CfnJobProps.Builder	destinationPackageVersions(List<String> destinationPackageVersions)	Sets the value of CfnJobProps.getDestinationPackageVersions()
CfnJobProps.Builder	document(String document)	Sets the value of CfnJobProps.getDocument()
CfnJobProps.Builder	documentParameters(Map<String,String> documentParameters)	Sets the value of CfnJobProps.getDocumentParameters()
CfnJobProps.Builder	documentParameters(IResolvable documentParameters)	Sets the value of CfnJobProps.getDocumentParameters()
CfnJobProps.Builder	documentSource(String documentSource)	Sets the value of CfnJobProps.getDocumentSource()
CfnJobProps.Builder	jobExecutionsRetryConfig(IResolvable jobExecutionsRetryConfig)	Sets the value of CfnJobProps.getJobExecutionsRetryConfig()
CfnJobProps.Builder	jobExecutionsRetryConfig(CfnJob.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig)	Sets the value of CfnJobProps.getJobExecutionsRetryConfig()
CfnJobProps.Builder	jobExecutionsRolloutConfig(IResolvable jobExecutionsRolloutConfig)	Sets the value of CfnJobProps.getJobExecutionsRolloutConfig()
CfnJobProps.Builder	jobExecutionsRolloutConfig(CfnJob.JobExecutionsRolloutConfigProperty jobExecutionsRolloutConfig)	Sets the value of CfnJobProps.getJobExecutionsRolloutConfig()
CfnJobProps.Builder	jobId(String jobId)	Sets the value of CfnJobProps.getJobId()
CfnJobProps.Builder	jobTemplateArn(String jobTemplateArn)	Sets the value of CfnJobProps.getJobTemplateArn()
CfnJobProps.Builder	presignedUrlConfig(IResolvable presignedUrlConfig)	Sets the value of CfnJobProps.getPresignedUrlConfig()
CfnJobProps.Builder	presignedUrlConfig(CfnJob.PresignedUrlConfigProperty presignedUrlConfig)	Sets the value of CfnJobProps.getPresignedUrlConfig()
CfnJobProps.Builder	schedulingConfig(IResolvable schedulingConfig)	Sets the value of CfnJobProps.getSchedulingConfig()
CfnJobProps.Builder	schedulingConfig(CfnJob.SchedulingConfigProperty schedulingConfig)	Sets the value of CfnJobProps.getSchedulingConfig()
CfnJobProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnJobProps.getTags()
CfnJobProps.Builder	targets(List<String> targets)	Sets the value of CfnJobProps.getTargets()
CfnJobProps.Builder	targetSelection(String targetSelection)	Sets the value of CfnJobProps.getTargetSelection()
CfnJobProps.Builder	timeoutConfig(IResolvable timeoutConfig)	Sets the value of CfnJobProps.getTimeoutConfig()
CfnJobProps.Builder	timeoutConfig(CfnJob.TimeoutConfigProperty timeoutConfig)	Sets the value of CfnJobProps.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

jobId

@Stability(Stable)
public CfnJobProps.Builder jobId(String jobId)

Sets the value of CfnJobProps.getJobId()

Parameters:

jobId - A job identifier which must be unique for your AWS account. This parameter is required. We recommend using a UUID. Alpha-numeric characters, '-' and '_' are valid for use here.

Returns:

this

targets

@Stability(Stable)
public CfnJobProps.Builder targets(List<String> targets)

Sets the value of CfnJobProps.getTargets()

Parameters:

targets - A list of things and thing groups to which the job should be sent. This parameter is required.

Returns:

this

abortConfig

@Stability(Stable)
public CfnJobProps.Builder abortConfig(IResolvable abortConfig)

Sets the value of CfnJobProps.getAbortConfig()

Parameters:

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

Returns:

this

abortConfig

@Stability(Stable)
public CfnJobProps.Builder abortConfig(CfnJob.AbortConfigProperty abortConfig)

Sets the value of CfnJobProps.getAbortConfig()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnJobProps.getDescription()

Parameters:

description - A short text description of the job.

Returns:

this

destinationPackageVersions

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

Sets the value of CfnJobProps.getDestinationPackageVersions()

Parameters:

destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.

Returns:

this

document

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

Sets the value of CfnJobProps.getDocument()

Parameters:

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

Returns:

this

documentParameters

@Stability(Stable)
public CfnJobProps.Builder documentParameters(IResolvable documentParameters)

Sets the value of CfnJobProps.getDocumentParameters()

Parameters:

documentParameters - Parameters of an Amazon Web Services managed template that you can specify to create the job document.

Returns:

this

documentParameters

@Stability(Stable)
public CfnJobProps.Builder documentParameters(Map<String,String> documentParameters)

Sets the value of CfnJobProps.getDocumentParameters()

Parameters:

documentParameters - Parameters of an Amazon Web Services managed template that you can specify to create the job document.

Returns:

this

documentSource

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

Sets the value of CfnJobProps.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.

Returns:

this

jobExecutionsRetryConfig

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

Sets the value of CfnJobProps.getJobExecutionsRetryConfig()

Parameters:

jobExecutionsRetryConfig - The configuration that determines how many retries are allowed for each failure type for a job.

Returns:

this

jobExecutionsRetryConfig

@Stability(Stable)
public CfnJobProps.Builder jobExecutionsRetryConfig(CfnJob.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig)

Sets the value of CfnJobProps.getJobExecutionsRetryConfig()

Parameters:

jobExecutionsRetryConfig - The configuration that determines how many retries are allowed for each failure type for a job.

Returns:

this

jobExecutionsRolloutConfig

@Stability(Stable)
public CfnJobProps.Builder jobExecutionsRolloutConfig(IResolvable jobExecutionsRolloutConfig)

Sets the value of CfnJobProps.getJobExecutionsRolloutConfig()

Parameters:

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

Returns:

this

jobExecutionsRolloutConfig

@Stability(Stable)
public CfnJobProps.Builder jobExecutionsRolloutConfig(CfnJob.JobExecutionsRolloutConfigProperty jobExecutionsRolloutConfig)

Sets the value of CfnJobProps.getJobExecutionsRolloutConfig()

Parameters:

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

Returns:

this

jobTemplateArn

@Stability(Stable)
public CfnJobProps.Builder jobTemplateArn(String jobTemplateArn)

Sets the value of CfnJobProps.getJobTemplateArn()

Parameters:

jobTemplateArn - The ARN of the job template used to create the job.

Returns:

this

presignedUrlConfig

@Stability(Stable)
public CfnJobProps.Builder presignedUrlConfig(IResolvable presignedUrlConfig)

Sets the value of CfnJobProps.getPresignedUrlConfig()

Parameters:

presignedUrlConfig - Configuration for pre-signed S3 URLs.

Returns:

this

presignedUrlConfig

@Stability(Stable)
public CfnJobProps.Builder presignedUrlConfig(CfnJob.PresignedUrlConfigProperty presignedUrlConfig)

Sets the value of CfnJobProps.getPresignedUrlConfig()

Parameters:

presignedUrlConfig - Configuration for pre-signed S3 URLs.

Returns:

this

schedulingConfig

@Stability(Stable)
public CfnJobProps.Builder schedulingConfig(IResolvable schedulingConfig)

Sets the value of CfnJobProps.getSchedulingConfig()

Parameters:

schedulingConfig - Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.

Returns:

this

schedulingConfig

@Stability(Stable)
public CfnJobProps.Builder schedulingConfig(CfnJob.SchedulingConfigProperty schedulingConfig)

Sets the value of CfnJobProps.getSchedulingConfig()

Parameters:

schedulingConfig - Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.

Returns:

this

tags

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

Sets the value of CfnJobProps.getTags()

Parameters:

tags - Metadata which can be used to manage the job.

Returns:

this

targetSelection

@Stability(Stable)
public CfnJobProps.Builder targetSelection(String targetSelection)

Sets the value of CfnJobProps.getTargetSelection()

Parameters:

targetSelection - Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT).

Returns:

this

timeoutConfig

@Stability(Stable)
public CfnJobProps.Builder timeoutConfig(IResolvable timeoutConfig)

Sets the value of CfnJobProps.getTimeoutConfig()

Parameters:

timeoutConfig - Specifies the amount of time each device has to finish its execution of the job.

Returns:

this

timeoutConfig

@Stability(Stable)
public CfnJobProps.Builder timeoutConfig(CfnJob.TimeoutConfigProperty timeoutConfig)

Sets the value of CfnJobProps.getTimeoutConfig()

Parameters:

timeoutConfig - Specifies the amount of time each device has to finish its execution of the job.

Returns:

this

build

@Stability(Stable)
public CfnJobProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnJobProps

Throws:

NullPointerException - if any required attribute was not provided