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

Class CfnJobPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobPropsMixin>

Enclosing class:

CfnJobPropsMixin

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

A fluent builder for CfnJobPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnJobPropsMixin.Builder	abortConfig(CfnJobPropsMixin.AbortConfigProperty abortConfig)	The criteria that determine when and how a job abort takes place.
CfnJobPropsMixin.Builder	abortConfig(IResolvable abortConfig)	The criteria that determine when and how a job abort takes place.
CfnJobPropsMixin	build()
static CfnJobPropsMixin.Builder	create()
static CfnJobPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnJobPropsMixin.Builder	description(String description)	A short text description of the job.
CfnJobPropsMixin.Builder	destinationPackageVersions(List<String> destinationPackageVersions)	The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
CfnJobPropsMixin.Builder	document(String document)	The job document.
CfnJobPropsMixin.Builder	documentParameters(Map<String,String> documentParameters)	Parameters of an Amazon Web Services managed template that you can specify to create the job document.
CfnJobPropsMixin.Builder	documentParameters(IResolvable documentParameters)	Parameters of an Amazon Web Services managed template that you can specify to create the job document.
CfnJobPropsMixin.Builder	documentSource(String documentSource)	An S3 link, or S3 object URL, to the job document.
CfnJobPropsMixin.Builder	jobExecutionsRetryConfig(CfnJobPropsMixin.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig)	The configuration that determines how many retries are allowed for each failure type for a job.
CfnJobPropsMixin.Builder	jobExecutionsRetryConfig(IResolvable jobExecutionsRetryConfig)	The configuration that determines how many retries are allowed for each failure type for a job.
CfnJobPropsMixin.Builder	jobExecutionsRolloutConfig(CfnJobPropsMixin.JobExecutionsRolloutConfigProperty jobExecutionsRolloutConfig)	Allows you to create a staged rollout of a job.
CfnJobPropsMixin.Builder	jobExecutionsRolloutConfig(IResolvable jobExecutionsRolloutConfig)	Allows you to create a staged rollout of a job.
CfnJobPropsMixin.Builder	jobId(String jobId)	A job identifier which must be unique for your AWS account.
CfnJobPropsMixin.Builder	jobTemplateArn(String jobTemplateArn)	The ARN of the job template used to create the job.
CfnJobPropsMixin.Builder	presignedUrlConfig(CfnJobPropsMixin.PresignedUrlConfigProperty presignedUrlConfig)	Configuration for pre-signed S3 URLs.
CfnJobPropsMixin.Builder	presignedUrlConfig(IResolvable presignedUrlConfig)	Configuration for pre-signed S3 URLs.
CfnJobPropsMixin.Builder	schedulingConfig(CfnJobPropsMixin.SchedulingConfigProperty schedulingConfig)	Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.
CfnJobPropsMixin.Builder	schedulingConfig(IResolvable schedulingConfig)	Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.
CfnJobPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Metadata which can be used to manage the job.
CfnJobPropsMixin.Builder	targets(List<String> targets)	A list of things and thing groups to which the job should be sent.
CfnJobPropsMixin.Builder	targetSelection(String 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).
CfnJobPropsMixin.Builder	timeoutConfig(CfnJobPropsMixin.TimeoutConfigProperty timeoutConfig)	Specifies the amount of time each device has to finish its execution of the job.
CfnJobPropsMixin.Builder	timeoutConfig(IResolvable timeoutConfig)	Specifies the amount of time each device has to finish its execution of the job.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnJobPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnJobPropsMixin.Builder.

create

@Stability(Stable)
public static CfnJobPropsMixin.Builder create()

Returns:

a new instance of CfnJobPropsMixin.Builder.

abortConfig

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

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

Parameters:

abortConfig - The criteria that determine when and how a job abort takes place. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-abortconfig

abortConfig

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

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

Parameters:

abortConfig - The criteria that determine when and how a job abort takes place. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-abortconfig

description

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

A short text description of the job.

Parameters:

description - A short text description of the job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-description

destinationPackageVersions

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-destinationpackageversions

document

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

The job document.

Required if you don't specify a value for documentSource.

Parameters:

document - The job document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-document

documentParameters

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-documentparameters

documentParameters

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-documentparameters

documentSource

@Stability(Stable)
public CfnJobPropsMixin.Builder documentSource(String 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.

Parameters:

documentSource - An S3 link, or S3 object URL, to the job document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-documentsource

jobExecutionsRetryConfig

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-jobexecutionsretryconfig

jobExecutionsRetryConfig

@Stability(Stable)
public CfnJobPropsMixin.Builder jobExecutionsRetryConfig(CfnJobPropsMixin.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig)

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-jobexecutionsretryconfig

jobExecutionsRolloutConfig

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

Allows you to create a staged rollout of a job.

Parameters:

jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-jobexecutionsrolloutconfig

jobExecutionsRolloutConfig

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

Allows you to create a staged rollout of a job.

Parameters:

jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-jobexecutionsrolloutconfig

jobId

@Stability(Stable)
public CfnJobPropsMixin.Builder jobId(String 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.

Parameters:

jobId - A job identifier which must be unique for your AWS account. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-jobid

jobTemplateArn

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

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

Parameters:

jobTemplateArn - The ARN of the job template used to create the job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-jobtemplatearn

presignedUrlConfig

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

Configuration for pre-signed S3 URLs.

Parameters:

presignedUrlConfig - Configuration for pre-signed S3 URLs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-presignedurlconfig

presignedUrlConfig

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

Configuration for pre-signed S3 URLs.

Parameters:

presignedUrlConfig - Configuration for pre-signed S3 URLs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-presignedurlconfig

schedulingConfig

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

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

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-schedulingconfig

schedulingConfig

@Stability(Stable)
public CfnJobPropsMixin.Builder schedulingConfig(CfnJobPropsMixin.SchedulingConfigProperty schedulingConfig)

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

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-schedulingconfig

tags

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

Metadata which can be used to manage the job.

Parameters:

tags - Metadata which can be used to manage the job. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-tags

targets

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-targets

targetSelection

@Stability(Stable)
public CfnJobPropsMixin.Builder targetSelection(String 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).

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). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-targetselection

timeoutConfig

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-timeoutconfig

timeoutConfig

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-job.html#cfn-iot-job-timeoutconfig

build

@Stability(Stable)
public CfnJobPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnJobPropsMixin.