Package software.amazon.awscdk.services.batch

Interface CfnJobDefinition.EvaluateOnExitProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.EvaluateOnExitProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(Stable)
public static interface CfnJobDefinition.EvaluateOnExitProperty
extends software.amazon.jsii.JsiiSerializable

Specifies an array of up to 5 conditions to be met, and an action to take ( RETRY or EXIT ) if all conditions are met.

If none of the EvaluateOnExit conditions in a RetryStrategy match, then the job is retried.

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.*;
 EvaluateOnExitProperty evaluateOnExitProperty = EvaluateOnExitProperty.builder()
         .action("action")
         // the properties below are optional
         .onExitCode("onExitCode")
         .onReason("onReason")
         .onStatusReason("onStatusReason")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobDefinition.EvaluateOnExitProperty.Builder	builder()
String	getAction()	Specifies the action to take if all of the specified conditions ( onStatusReason , onReason , and onExitCode ) are met.
default String	getOnExitCode()	Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job.
default String	getOnReason()	Contains a glob pattern to match against the Reason returned for a job.
default String	getOnStatusReason()	Contains a glob pattern to match against the StatusReason returned for a job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
String getAction()

Specifies the action to take if all of the specified conditions ( onStatusReason , onReason , and onExitCode ) are met.

The values aren't case sensitive.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-action

getOnExitCode

@Stability(Stable)
@Nullable
default String getOnExitCode()

Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job.

The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can contain up to 512 characters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onexitcode

getOnReason

@Stability(Stable)
@Nullable
default String getOnReason()

Contains a glob pattern to match against the Reason returned for a job.

The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onreason

getOnStatusReason

@Stability(Stable)
@Nullable
default String getOnStatusReason()

Contains a glob pattern to match against the StatusReason returned for a job.

The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onstatusreason

builder

@Stability(Stable)
static CfnJobDefinition.EvaluateOnExitProperty.Builder builder()

Returns:

a CfnJobDefinition.EvaluateOnExitProperty.Builder of CfnJobDefinition.EvaluateOnExitProperty