Package software.amazon.awscdk.services.greengrassv2

Interface CfnDeployment.IoTJobAbortCriteriaProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.IoTJobAbortCriteriaProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

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

Contains criteria that define when and how to cancel a job.

The deployment stops if the following conditions are true:

• The number of things that receive the deployment exceeds the minNumberOfExecutedThings .
• The percentage of failures with type failureType exceeds the thresholdPercentage .

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

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeployment.IoTJobAbortCriteriaProperty.Builder	builder()
String	getAction()	The action to perform when the criteria are met.
String	getFailureType()	The type of job deployment failure that can cancel a job.
Number	getMinNumberOfExecutedThings()	The minimum number of things that receive the configuration before the job can cancel.
Number	getThresholdPercentage()	The minimum percentage of failureType failures that occur before the job can cancel.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
String getAction()

The action to perform when the criteria are met.

See Also:

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

getFailureType

@Stability(Stable)
@NotNull
String getFailureType()

The type of job deployment failure that can cancel a job.

See Also:

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

getMinNumberOfExecutedThings

@Stability(Stable)
@NotNull
Number getMinNumberOfExecutedThings()

The minimum number of things that receive the configuration before the job can cancel.

See Also:

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

getThresholdPercentage

@Stability(Stable)
@NotNull
Number getThresholdPercentage()

The minimum percentage of failureType failures that occur before the job can cancel.

This parameter supports up to two digits after the decimal (for example, you can specify 10.9 or 10.99 , but not 10.999 ).

See Also:

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

builder

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

Returns:

a CfnDeployment.IoTJobAbortCriteriaProperty.Builder of CfnDeployment.IoTJobAbortCriteriaProperty