interface IoTJobAbortCriteriaProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.GreengrassV2.CfnDeployment.IoTJobAbortCriteriaProperty |
Java | software.amazon.awscdk.services.greengrassv2.CfnDeployment.IoTJobAbortCriteriaProperty |
Python | aws_cdk.aws_greengrassv2.CfnDeployment.IoTJobAbortCriteriaProperty |
TypeScript | @aws-cdk/aws-greengrassv2 » CfnDeployment » 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
failureType
exceeds thethresholdPercentage
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as greengrassv2 from '@aws-cdk/aws-greengrassv2';
const ioTJobAbortCriteriaProperty: greengrassv2.CfnDeployment.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
The action to perform when the criteria are met.
failureType
Type:
string
The type of job deployment failure that can cancel a job.
minNumberOfExecutedThings
Type:
number
The minimum number of things that receive the configuration before the job can cancel.
thresholdPercentage
Type:
number
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
).