interface IoTJobAbortCriteriaProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.GreengrassV2.Mixins.CfnDeploymentPropsMixin.IoTJobAbortCriteriaProperty |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsgreengrassv2/mixins#CfnDeploymentPropsMixin_IoTJobAbortCriteriaProperty |
Java | software.amazon.awscdk.mixins.preview.services.greengrassv2.mixins.CfnDeploymentPropsMixin.IoTJobAbortCriteriaProperty |
Python | aws_cdk.mixins_preview.aws_greengrassv2.mixins.CfnDeploymentPropsMixin.IoTJobAbortCriteriaProperty |
TypeScript | @aws-cdk/mixins-preview » aws_greengrassv2 » mixins » CfnDeploymentPropsMixin » IoTJobAbortCriteriaProperty |
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
failureTypeexceeds thethresholdPercentage.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as greengrassv2_mixins } from '@aws-cdk/mixins-preview/aws-greengrassv2';
const ioTJobAbortCriteriaProperty: greengrassv2_mixins.CfnDeploymentPropsMixin.IoTJobAbortCriteriaProperty = {
action: 'action',
failureType: 'failureType',
minNumberOfExecutedThings: 123,
thresholdPercentage: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| action? | string | The action to perform when the criteria are met. |
| failure | string | The type of job deployment failure that can cancel a job. |
| min | number | The minimum number of things that receive the configuration before the job can cancel. |
| threshold | number | The minimum percentage of failureType failures that occur before the job can cancel. |
action?
Type:
string
(optional)
The action to perform when the criteria are met.
failureType?
Type:
string
(optional)
The type of job deployment failure that can cancel a job.
minNumberOfExecutedThings?
Type:
number
(optional)
The minimum number of things that receive the configuration before the job can cancel.
thresholdPercentage?
Type:
number
(optional)
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 ).

.NET
Go
Java
Python
TypeScript