aws-cdk-lib.aws_greengrassv2.CfnDeployment.IoTJobAbortCriteriaProperty

interface IoTJobAbortCriteriaProperty

LanguageType name
.NETAmazon.CDK.AWS.GreengrassV2.CfnDeployment.IoTJobAbortCriteriaProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsgreengrassv2#CfnDeployment_IoTJobAbortCriteriaProperty
Javasoftware.amazon.awscdk.services.greengrassv2.CfnDeployment.IoTJobAbortCriteriaProperty
Pythonaws_cdk.aws_greengrassv2.CfnDeployment.IoTJobAbortCriteriaProperty
TypeScript aws-cdk-lib » 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 the thresholdPercentage .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_greengrassv2 as greengrassv2 } from 'aws-cdk-lib';
const ioTJobAbortCriteriaProperty: greengrassv2.CfnDeployment.IoTJobAbortCriteriaProperty = {
  action: 'action',
  failureType: 'failureType',
  minNumberOfExecutedThings: 123,
  thresholdPercentage: 123,
};

Properties

NameTypeDescription
actionstringThe action to perform when the criteria are met.
failureTypestringThe type of job deployment failure that can cancel a job.
minNumberOfExecutedThingsnumberThe minimum number of things that receive the configuration before the job can cancel.
thresholdPercentagenumberThe 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 ).