Package software.amazon.awscdk.services.iot

Interface CfnJobTemplate.AbortCriteriaProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobTemplate.AbortCriteriaProperty.Jsii$Proxy

Enclosing class:

CfnJobTemplate

@Stability(Stable)
public static interface CfnJobTemplate.AbortCriteriaProperty
extends software.amazon.jsii.JsiiSerializable

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

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.iot.*;
 AbortCriteriaProperty abortCriteriaProperty = AbortCriteriaProperty.builder()
         .action("action")
         .failureType("failureType")
         .minNumberOfExecutedThings(123)
         .thresholdPercentage(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobTemplate.AbortCriteriaProperty.Builder	builder()
String	getAction()	The type of job action to take to initiate the job abort.
String	getFailureType()	The type of job execution failures that can initiate a job abort.
Number	getMinNumberOfExecutedThings()	The minimum number of things which must receive job execution notifications before the job can be aborted.
Number	getThresholdPercentage()	The minimum percentage of job execution failures that must occur to initiate the job abort.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
String getAction()

The type of job action to take to initiate the job abort.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-action

getFailureType

@Stability(Stable)
@NotNull
String getFailureType()

The type of job execution failures that can initiate a job abort.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-failuretype

getMinNumberOfExecutedThings

@Stability(Stable)
@NotNull
Number getMinNumberOfExecutedThings()

The minimum number of things which must receive job execution notifications before the job can be aborted.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-minnumberofexecutedthings

getThresholdPercentage

@Stability(Stable)
@NotNull
Number getThresholdPercentage()

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html#cfn-iot-jobtemplate-abortcriteria-thresholdpercentage

builder

@Stability(Stable)
static CfnJobTemplate.AbortCriteriaProperty.Builder builder()

Returns:

a CfnJobTemplate.AbortCriteriaProperty.Builder of CfnJobTemplate.AbortCriteriaProperty