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

Class CfnJobMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobMixinProps>

Enclosing interface:

CfnJobMixinProps

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

A builder for CfnJobMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of CfnJobMixinProps.getAbortConfig()

Parameters:

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

Returns:

this

abortConfig

@Stability(Stable)
public CfnJobMixinProps.Builder abortConfig(CfnJobPropsMixin.AbortConfigProperty abortConfig)

Sets the value of CfnJobMixinProps.getAbortConfig()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnJobMixinProps.getDescription()

Parameters:

description - A short text description of the job.

Returns:

this

destinationPackageVersions

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

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

Sets the value of CfnJobMixinProps.getDocument()

Parameters:

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

Returns:

this

documentParameters

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

Sets the value of CfnJobMixinProps.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 CfnJobMixinProps.Builder documentParameters(Map<String,String> documentParameters)

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

Sets the value of CfnJobMixinProps.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 CfnJobMixinProps.Builder jobExecutionsRetryConfig(IResolvable jobExecutionsRetryConfig)

Sets the value of CfnJobMixinProps.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 CfnJobMixinProps.Builder jobExecutionsRetryConfig(CfnJobPropsMixin.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig)

Sets the value of CfnJobMixinProps.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 CfnJobMixinProps.Builder jobExecutionsRolloutConfig(IResolvable jobExecutionsRolloutConfig)

Sets the value of CfnJobMixinProps.getJobExecutionsRolloutConfig()

Parameters:

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

Returns:

this

jobExecutionsRolloutConfig

@Stability(Stable)
public CfnJobMixinProps.Builder jobExecutionsRolloutConfig(CfnJobPropsMixin.JobExecutionsRolloutConfigProperty jobExecutionsRolloutConfig)

Sets the value of CfnJobMixinProps.getJobExecutionsRolloutConfig()

Parameters:

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

Returns:

this

jobId

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

Sets the value of CfnJobMixinProps.getJobId()

Parameters:

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

Returns:

this

jobTemplateArn

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

Sets the value of CfnJobMixinProps.getJobTemplateArn()

Parameters:

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

Returns:

this

presignedUrlConfig

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

Sets the value of CfnJobMixinProps.getPresignedUrlConfig()

Parameters:

presignedUrlConfig - Configuration for pre-signed S3 URLs.

Returns:

this

presignedUrlConfig

@Stability(Stable)
public CfnJobMixinProps.Builder presignedUrlConfig(CfnJobPropsMixin.PresignedUrlConfigProperty presignedUrlConfig)

Sets the value of CfnJobMixinProps.getPresignedUrlConfig()

Parameters:

presignedUrlConfig - Configuration for pre-signed S3 URLs.

Returns:

this

schedulingConfig

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

Sets the value of CfnJobMixinProps.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 CfnJobMixinProps.Builder schedulingConfig(CfnJobPropsMixin.SchedulingConfigProperty schedulingConfig)

Sets the value of CfnJobMixinProps.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 CfnJobMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnJobMixinProps.getTags()

Parameters:

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

Returns:

this

targets

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

Sets the value of CfnJobMixinProps.getTargets()

Parameters:

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

Returns:

this

targetSelection

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

Sets the value of CfnJobMixinProps.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 CfnJobMixinProps.Builder timeoutConfig(IResolvable timeoutConfig)

Sets the value of CfnJobMixinProps.getTimeoutConfig()

Parameters:

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

Returns:

this

timeoutConfig

@Stability(Stable)
public CfnJobMixinProps.Builder timeoutConfig(CfnJobPropsMixin.TimeoutConfigProperty timeoutConfig)

Sets the value of CfnJobMixinProps.getTimeoutConfig()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnJobMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnJobMixinProps

Throws:

NullPointerException - if any required attribute was not provided