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

Interface CfnJobTemplatePropsMixin.AbortCriteriaProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobTemplatePropsMixin.AbortCriteriaProperty.Jsii$Proxy

Enclosing class:

CfnJobTemplatePropsMixin

@Stability(Stable)
public static interface CfnJobTemplatePropsMixin.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.cfnpropertymixins.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	CfnJobTemplatePropsMixin.AbortCriteriaProperty.Builder	A builder for CfnJobTemplatePropsMixin.AbortCriteriaProperty
static final class	CfnJobTemplatePropsMixin.AbortCriteriaProperty.Jsii$Proxy	An implementation for CfnJobTemplatePropsMixin.AbortCriteriaProperty

Method Summary

Modifier and Type	Method	Description
static CfnJobTemplatePropsMixin.AbortCriteriaProperty.Builder	builder()
default String	getAction()	The type of job action to take to initiate the job abort.
default String	getFailureType()	The type of job execution failures that can initiate a job abort.
default Number	getMinNumberOfExecutedThings()	The minimum number of things which must receive job execution notifications before the job can be aborted.
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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 CfnJobTemplatePropsMixin.AbortCriteriaProperty.Builder builder()

Returns:

a CfnJobTemplatePropsMixin.AbortCriteriaProperty.Builder of CfnJobTemplatePropsMixin.AbortCriteriaProperty