Package software.amazon.awscdk.cfnpropertymixins.services.batch

Interface CfnJobQueuePropsMixin.JobStateTimeLimitActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobQueuePropsMixin.JobStateTimeLimitActionProperty.Jsii$Proxy

Enclosing class:

CfnJobQueuePropsMixin

@Stability(Stable)
public static interface CfnJobQueuePropsMixin.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.cfnpropertymixins.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	CfnJobQueuePropsMixin.JobStateTimeLimitActionProperty.Builder	A builder for CfnJobQueuePropsMixin.JobStateTimeLimitActionProperty
static final class	CfnJobQueuePropsMixin.JobStateTimeLimitActionProperty.Jsii$Proxy	An implementation for CfnJobQueuePropsMixin.JobStateTimeLimitActionProperty

Method Summary

Modifier and Type	Method	Description
static CfnJobQueuePropsMixin.JobStateTimeLimitActionProperty.Builder	builder()
default 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.
default Number	getMaxTimeSeconds()	The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken.
default String	getReason()	The reason to log for the action being taken.
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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 CfnJobQueuePropsMixin.JobStateTimeLimitActionProperty.Builder builder()

Returns:

a CfnJobQueuePropsMixin.JobStateTimeLimitActionProperty.Builder of CfnJobQueuePropsMixin.JobStateTimeLimitActionProperty