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

Class CfnJobPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.iot.CfnJobPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:28.466Z") @Stability(Stable) public class CfnJobPropsMixin extends Mixin implements software.constructs.IMixin
Use the AWS::IoT::Job resource to declare an AWS IoT job.

A job can be used to define a set of remote operations that are sent to and run on one or more devices (things or thing groups) connected to AWS IoT.

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnJobPropsMixin cfnJobPropsMixin = CfnJobPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnJobPropsMixin

      protected CfnJobPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnJobPropsMixin

      protected CfnJobPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnJobPropsMixin

      @Stability(Stable) public CfnJobPropsMixin(@NotNull CfnJobMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::IoT::Job.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnJobPropsMixin

      @Stability(Stable) public CfnJobPropsMixin(@NotNull CfnJobMixinProps props)
      Create a mixin to apply properties to AWS::IoT::Job.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnJobMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()