Package software.amazon.awscdk.services.batch

Interface JobDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

EcsJobDefinitionProps, EksJobDefinitionProps, MultiNodeJobDefinitionProps

All Known Implementing Classes:

EcsJobDefinitionProps.Jsii$Proxy, EksJobDefinitionProps.Jsii$Proxy, JobDefinitionProps.Jsii$Proxy, MultiNodeJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:22.086Z")
@Stability(Stable)
public interface JobDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Props common to all JobDefinitions.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.batch.*;
 Object parameters;
 RetryStrategy retryStrategy;
 JobDefinitionProps jobDefinitionProps = JobDefinitionProps.builder()
         .jobDefinitionName("jobDefinitionName")
         .parameters(Map.of(
                 "parametersKey", parameters))
         .retryAttempts(123)
         .retryStrategies(List.of(retryStrategy))
         .schedulingPriority(123)
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static JobDefinitionProps.Builder	builder()
default String	getJobDefinitionName()	The name of this job definition.
default Map<String,Object>	getParameters()	The default parameters passed to the container These parameters can be referenced in the command that you give to the container.
default Number	getRetryAttempts()	The number of times to retry a job.
default List<RetryStrategy>	getRetryStrategies()	Defines the retry behavior for this job.
default Number	getSchedulingPriority()	The priority of this Job.
default Duration	getTimeout()	The timeout time for jobs that are submitted with this job definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getJobDefinitionName

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

The name of this job definition.

Default: - generated by CloudFormation

getParameters

@Stability(Stable)
@Nullable
default Map<String,Object> getParameters()

The default parameters passed to the container These parameters can be referenced in the command that you give to the container.

Default: none

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html#parameters

getRetryAttempts

@Stability(Stable)
@Nullable
default Number getRetryAttempts()

The number of times to retry a job.

The job is retried on failure the same number of attempts as the value.

Default: 1

getRetryStrategies

@Stability(Stable)
@Nullable
default List<RetryStrategy> getRetryStrategies()

Defines the retry behavior for this job.

Default: - no `RetryStrategy`

getSchedulingPriority

@Stability(Stable)
@Nullable
default Number getSchedulingPriority()

The priority of this Job.

Only used in Fairshare Scheduling to decide which job to run first when there are multiple jobs with the same share identifier.

Default: none

getTimeout

@Stability(Stable)
@Nullable
default Duration getTimeout()

The timeout time for jobs that are submitted with this job definition.

After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

Default: - no timeout

builder

@Stability(Stable)
static JobDefinitionProps.Builder builder()

Returns:

a JobDefinitionProps.Builder of JobDefinitionProps