Package software.amazon.awscdk.services.iot

Class CfnJobTemplate.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnJobTemplate.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobTemplate>

Enclosing class:

CfnJobTemplate

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

A fluent builder for CfnJobTemplate.

Method Summary

Modifier and Type	Method	Description
CfnJobTemplate.Builder	abortConfig(Object abortConfig)	The criteria that determine when and how a job abort takes place.
CfnJobTemplate	build()
static CfnJobTemplate.Builder	create(software.constructs.Construct scope, String id)
CfnJobTemplate.Builder	description(String description)	A description of the job template.
CfnJobTemplate.Builder	destinationPackageVersions(List<String> destinationPackageVersions)	The package version Amazon Resource Names (ARNs) that are installed on the device’s reserved named shadow ( $package ) when the job successfully completes.
CfnJobTemplate.Builder	document(String document)	The job document.
CfnJobTemplate.Builder	documentSource(String documentSource)	An S3 link, or S3 object URL, to the job document.
CfnJobTemplate.Builder	jobArn(String jobArn)	The ARN of the job to use as the basis for the job template.
CfnJobTemplate.Builder	jobExecutionsRetryConfig(IResolvable jobExecutionsRetryConfig)	Allows you to create the criteria to retry a job.
CfnJobTemplate.Builder	jobExecutionsRetryConfig(CfnJobTemplate.JobExecutionsRetryConfigProperty jobExecutionsRetryConfig)	Allows you to create the criteria to retry a job.
CfnJobTemplate.Builder	jobExecutionsRolloutConfig(Object jobExecutionsRolloutConfig)	Allows you to create a staged rollout of a job.
CfnJobTemplate.Builder	jobTemplateId(String jobTemplateId)	A unique identifier for the job template.
CfnJobTemplate.Builder	maintenanceWindows(List<? extends Object> 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.
CfnJobTemplate.Builder	maintenanceWindows(IResolvable 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.
CfnJobTemplate.Builder	presignedUrlConfig(Object presignedUrlConfig)	Configuration for pre-signed S3 URLs.
CfnJobTemplate.Builder	tags(List<? extends CfnTag> tags)	Metadata that can be used to manage the job template.
CfnJobTemplate.Builder	timeoutConfig(Object 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 CfnJobTemplate.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnJobTemplate.Builder.

description

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

A description of the job template.

Parameters:

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

Returns:

this

See Also:

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

jobTemplateId

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

A unique identifier for the job template.

We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

Parameters:

jobTemplateId - A unique identifier for the job template. This parameter is required.

Returns:

this

See Also:

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

abortConfig

@Stability(Stable)
public CfnJobTemplate.Builder abortConfig(Object 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-jobtemplate.html#cfn-iot-jobtemplate-abortconfig

destinationPackageVersions

@Stability(Stable)
public CfnJobTemplate.Builder destinationPackageVersions(List<String> 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.

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

Returns:

this

See Also:

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

document

@Stability(Stable)
public CfnJobTemplate.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-jobtemplate.html#cfn-iot-jobtemplate-document

documentSource

@Stability(Stable)
public CfnJobTemplate.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 .

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 .

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-jobtemplate.html#cfn-iot-jobtemplate-documentsource

jobArn

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

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

Parameters:

jobArn - The ARN of the job to use as the basis for the job template. This parameter is required.

Returns:

this

See Also:

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

jobExecutionsRetryConfig

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

Allows you to create the criteria to retry a job.

Parameters:

jobExecutionsRetryConfig - Allows you to create the criteria to retry a job. This parameter is required.

Returns:

this

See Also:

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

jobExecutionsRetryConfig

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

Allows you to create the criteria to retry a job.

Parameters:

jobExecutionsRetryConfig - Allows you to create the criteria to retry a job. This parameter is required.

Returns:

this

See Also:

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

jobExecutionsRolloutConfig

@Stability(Stable)
public CfnJobTemplate.Builder jobExecutionsRolloutConfig(Object 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-jobtemplate.html#cfn-iot-jobtemplate-jobexecutionsrolloutconfig

maintenanceWindows

@Stability(Stable)
public CfnJobTemplate.Builder maintenanceWindows(IResolvable 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.

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

Returns:

this

See Also:

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

maintenanceWindows

@Stability(Stable)
public CfnJobTemplate.Builder maintenanceWindows(List<? extends Object> 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.

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

Returns:

this

See Also:

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

presignedUrlConfig

@Stability(Stable)
public CfnJobTemplate.Builder presignedUrlConfig(Object 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-jobtemplate.html#cfn-iot-jobtemplate-presignedurlconfig

tags

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

Metadata that can be used to manage the job template.

Parameters:

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

Returns:

this

See Also:

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

timeoutConfig

@Stability(Stable)
public CfnJobTemplate.Builder timeoutConfig(Object 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 .

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-jobtemplate.html#cfn-iot-jobtemplate-timeoutconfig

build

@Stability(Stable)
public CfnJobTemplate build()

Specified by:

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

Returns:

a newly built instance of CfnJobTemplate.