software.amazon.awscdk.services.batch

Interface CfnJobDefinition.RetryStrategyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.RetryStrategyProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(value=Stable)
public static interface CfnJobDefinition.RetryStrategyProperty
extends software.amazon.jsii.JsiiSerializable

The retry strategy associated with a job.

For more information, see Automated job retries in the AWS Batch User Guide .

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.batch.*;
 RetryStrategyProperty retryStrategyProperty = RetryStrategyProperty.builder()
         .attempts(123)
         .evaluateOnExit(List.of(EvaluateOnExitProperty.builder()
                 .action("action")
                 // the properties below are optional
                 .onExitCode("onExitCode")
                 .onReason("onReason")
                 .onStatusReason("onStatusReason")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnJobDefinition.RetryStrategyProperty.Builder A builder for CfnJobDefinition.RetryStrategyProperty
static class	CfnJobDefinition.RetryStrategyProperty.Jsii$Proxy An implementation for CfnJobDefinition.RetryStrategyProperty

Method Summary

Modifier and Type	Method and Description
static CfnJobDefinition.RetryStrategyProperty.Builder	builder()
default Number	getAttempts() The number of times to move a job to the `RUNNABLE` status.
default Object	getEvaluateOnExit() Array of up to 5 objects that specify conditions under which the job should be retried or failed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttempts

@Stability(value=Stable)
 @Nullable
default Number getAttempts()

The number of times to move a job to the `RUNNABLE` status.

You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

getEvaluateOnExit

@Stability(value=Stable)
 @Nullable
default Object getEvaluateOnExit()

Array of up to 5 objects that specify conditions under which the job should be retried or failed.

If this parameter is specified, then the attempts parameter must also be specified.

builder

@Stability(value=Stable)
static CfnJobDefinition.RetryStrategyProperty.Builder builder()

Returns:

a CfnJobDefinition.RetryStrategyProperty.Builder of CfnJobDefinition.RetryStrategyProperty