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

Interface CfnJobMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:28.453Z")
@Stability(Stable)
public interface CfnJobMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnJobPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iot.*;
 CfnJobMixinProps cfnJobMixinProps = CfnJobMixinProps.builder()
         .abortConfig(AbortConfigProperty.builder()
                 .criteriaList(List.of(AbortCriteriaProperty.builder()
                         .action("action")
                         .failureType("failureType")
                         .minNumberOfExecutedThings(123)
                         .thresholdPercentage(123)
                         .build()))
                 .build())
         .description("description")
         .destinationPackageVersions(List.of("destinationPackageVersions"))
         .document("document")
         .documentParameters(Map.of(
                 "documentParametersKey", "documentParameters"))
         .documentSource("documentSource")
         .jobExecutionsRetryConfig(JobExecutionsRetryConfigProperty.builder()
                 .criteriaList(List.of(RetryCriteriaProperty.builder()
                         .failureType("failureType")
                         .numberOfRetries(123)
                         .build()))
                 .build())
         .jobExecutionsRolloutConfig(JobExecutionsRolloutConfigProperty.builder()
                 .exponentialRate(ExponentialRolloutRateProperty.builder()
                         .baseRatePerMinute(123)
                         .incrementFactor(123)
                         .rateIncreaseCriteria(RateIncreaseCriteriaProperty.builder()
                                 .numberOfNotifiedThings(123)
                                 .numberOfSucceededThings(123)
                                 .build())
                         .build())
                 .maximumPerMinute(123)
                 .build())
         .jobId("jobId")
         .jobTemplateArn("jobTemplateArn")
         .presignedUrlConfig(PresignedUrlConfigProperty.builder()
                 .expiresInSec(123)
                 .roleArn("roleArn")
                 .build())
         .schedulingConfig(SchedulingConfigProperty.builder()
                 .endBehavior("endBehavior")
                 .endTime("endTime")
                 .maintenanceWindows(List.of(MaintenanceWindowProperty.builder()
                         .durationInMinutes(123)
                         .startTime("startTime")
                         .build()))
                 .startTime("startTime")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targets(List.of("targets"))
         .targetSelection("targetSelection")
         .timeoutConfig(TimeoutConfigProperty.builder()
                 .inProgressTimeoutInMinutes(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJobMixinProps.Builder	A builder for CfnJobMixinProps
static final class	CfnJobMixinProps.Jsii$Proxy	An implementation for CfnJobMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnJobMixinProps.Builder	builder()
default Object	getAbortConfig()	The criteria that determine when and how a job abort takes place.
default String	getDescription()	A short text description of the job.
default List<String>	getDestinationPackageVersions()	The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
default String	getDocument()	The job document.
default Object	getDocumentParameters()	Parameters of an Amazon Web Services managed template that you can specify to create the job document.
default String	getDocumentSource()	An S3 link, or S3 object URL, to the job document.
default Object	getJobExecutionsRetryConfig()	The configuration that determines how many retries are allowed for each failure type for a job.
default Object	getJobExecutionsRolloutConfig()	Allows you to create a staged rollout of a job.
default String	getJobId()	A job identifier which must be unique for your AWS account.
default String	getJobTemplateArn()	The ARN of the job template used to create the job.
default Object	getPresignedUrlConfig()	Configuration for pre-signed S3 URLs.
default Object	getSchedulingConfig()	Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group.
default List<CfnTag>	getTags()	Metadata which can be used to manage the job.
default List<String>	getTargets()	A list of things and thing groups to which the job should be sent.
default String	getTargetSelection()	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).
default Object	getTimeoutConfig()	Specifies the amount of time each device has to finish its execution of the job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAbortConfig

@Stability(Stable)
@Nullable
default Object getAbortConfig()

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

Returns union: either IResolvable or CfnJobPropsMixin.AbortConfigProperty

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A short text description of the job.

See Also:

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

getDestinationPackageVersions

@Stability(Stable)
@Nullable
default List<String> getDestinationPackageVersions()

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

See Also:

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

getDocument

@Stability(Stable)
@Nullable
default String getDocument()

The job document.

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

See Also:

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

getDocumentParameters

@Stability(Stable)
@Nullable
default Object getDocumentParameters()

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

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

See Also:

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

getDocumentSource

@Stability(Stable)
@Nullable
default String getDocumentSource()

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.

See Also:

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

getJobExecutionsRetryConfig

@Stability(Stable)
@Nullable
default Object getJobExecutionsRetryConfig()

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

Returns union: either IResolvable or CfnJobPropsMixin.JobExecutionsRetryConfigProperty

See Also:

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

getJobExecutionsRolloutConfig

@Stability(Stable)
@Nullable
default Object getJobExecutionsRolloutConfig()

Allows you to create a staged rollout of a job.

Returns union: either IResolvable or CfnJobPropsMixin.JobExecutionsRolloutConfigProperty

See Also:

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

getJobId

@Stability(Stable)
@Nullable
default String getJobId()

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.

See Also:

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

getJobTemplateArn

@Stability(Stable)
@Nullable
default String getJobTemplateArn()

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

See Also:

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

getPresignedUrlConfig

@Stability(Stable)
@Nullable
default Object getPresignedUrlConfig()

Configuration for pre-signed S3 URLs.

Returns union: either IResolvable or CfnJobPropsMixin.PresignedUrlConfigProperty

See Also:

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

getSchedulingConfig

@Stability(Stable)
@Nullable
default Object getSchedulingConfig()

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

Returns union: either IResolvable or CfnJobPropsMixin.SchedulingConfigProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata which can be used to manage the job.

See Also:

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

getTargets

@Stability(Stable)
@Nullable
default List<String> getTargets()

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

See Also:

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

getTargetSelection

@Stability(Stable)
@Nullable
default String getTargetSelection()

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).

See Also:

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

getTimeoutConfig

@Stability(Stable)
@Nullable
default Object getTimeoutConfig()

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

Returns union: either IResolvable or CfnJobPropsMixin.TimeoutConfigProperty

See Also:

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

builder

@Stability(Stable)
static CfnJobMixinProps.Builder builder()

Returns:

a CfnJobMixinProps.Builder of CfnJobMixinProps