Package software.amazon.awscdk.services.greengrassv2

Interface CfnDeployment.DeploymentIoTJobConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.DeploymentIoTJobConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

@Stability(Stable)
public static interface CfnDeployment.DeploymentIoTJobConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Contains information about an AWS IoT job configuration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.greengrassv2.*;
 Object rateIncreaseCriteria;
 DeploymentIoTJobConfigurationProperty deploymentIoTJobConfigurationProperty = DeploymentIoTJobConfigurationProperty.builder()
         .abortConfig(IoTJobAbortConfigProperty.builder()
                 .criteriaList(List.of(IoTJobAbortCriteriaProperty.builder()
                         .action("action")
                         .failureType("failureType")
                         .minNumberOfExecutedThings(123)
                         .thresholdPercentage(123)
                         .build()))
                 .build())
         .jobExecutionsRolloutConfig(IoTJobExecutionsRolloutConfigProperty.builder()
                 .exponentialRate(IoTJobExponentialRolloutRateProperty.builder()
                         .baseRatePerMinute(123)
                         .incrementFactor(123)
                         .rateIncreaseCriteria(rateIncreaseCriteria)
                         .build())
                 .maximumPerMinute(123)
                 .build())
         .timeoutConfig(IoTJobTimeoutConfigProperty.builder()
                 .inProgressTimeoutInMinutes(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeployment.DeploymentIoTJobConfigurationProperty.Builder	builder()
default Object	getAbortConfig()	The stop configuration for the job.
default Object	getJobExecutionsRolloutConfig()	The rollout configuration for the job.
default Object	getTimeoutConfig()	The timeout configuration for the job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAbortConfig

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

The stop configuration for the job.

This configuration defines when and how to stop a job rollout.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-abortconfig

getJobExecutionsRolloutConfig

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

The rollout configuration for the job.

This configuration defines the rate at which the job rolls out to the fleet of target devices.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-jobexecutionsrolloutconfig

getTimeoutConfig

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

The timeout configuration for the job.

This configuration defines the amount of time each device has to complete the job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html#cfn-greengrassv2-deployment-deploymentiotjobconfiguration-timeoutconfig

builder

@Stability(Stable)
static CfnDeployment.DeploymentIoTJobConfigurationProperty.Builder builder()

Returns:

a CfnDeployment.DeploymentIoTJobConfigurationProperty.Builder of CfnDeployment.DeploymentIoTJobConfigurationProperty