Package software.amazon.awscdk.services.batch

Interface CfnJobQueue.JobStateTimeLimitActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobQueue.JobStateTimeLimitActionProperty.Jsii$Proxy

Enclosing class:

CfnJobQueue

@Stability(Stable)
public static interface CfnJobQueue.JobStateTimeLimitActionProperty
extends software.amazon.jsii.JsiiSerializable

Specifies an action that AWS Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.

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.*;
 JobStateTimeLimitActionProperty jobStateTimeLimitActionProperty = JobStateTimeLimitActionProperty.builder()
         .action("action")
         .maxTimeSeconds(123)
         .reason("reason")
         .state("state")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobQueue.JobStateTimeLimitActionProperty.Builder	builder()
String	getAction()	The action to take when a job is at the head of the job queue in the specified state for the specified period of time.
Number	getMaxTimeSeconds()	The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken.
String	getReason()	The reason to log for the action being taken.
String	getState()	The state of the job needed to trigger the action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
String getAction()

The action to take when a job is at the head of the job queue in the specified state for the specified period of time.

The only supported value is CANCEL , which will cancel the job.

See Also:

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

getMaxTimeSeconds

@Stability(Stable)
@NotNull
Number getMaxTimeSeconds()

The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken.

The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-maxtimeseconds

getReason

@Stability(Stable)
@NotNull
String getReason()

The reason to log for the action being taken.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-reason

getState

@Stability(Stable)
@NotNull
String getState()

The state of the job needed to trigger the action.

The only supported value is RUNNABLE .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-jobstatetimelimitaction.html#cfn-batch-jobqueue-jobstatetimelimitaction-state

builder

@Stability(Stable)
static CfnJobQueue.JobStateTimeLimitActionProperty.Builder builder()

Returns:

a CfnJobQueue.JobStateTimeLimitActionProperty.Builder of CfnJobQueue.JobStateTimeLimitActionProperty