Package software.amazon.awscdk.services.batch

Class EksJobDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.batch.EksJobDefinition

All Implemented Interfaces:

IResource, IEksJobDefinition, IJobDefinition, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:12.008Z")
@Stability(Stable)
public class EksJobDefinition
extends Resource
implements IEksJobDefinition, IJobDefinition

A JobDefinition that uses Eks orchestration.

Example:

 EksJobDefinition jobDefn = EksJobDefinition.Builder.create(this, "eksf2")
         .container(EksContainerDefinition.Builder.create(this, "container")
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .volumes(List.of(EksVolume.emptyDir(EmptyDirVolumeOptions.builder()
                         .name("myEmptyDirVolume")
                         .mountPath("/mount/path")
                         .medium(EmptyDirMediumType.MEMORY)
                         .readonly(true)
                         .sizeLimit(Size.mebibytes(2048))
                         .build())))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EksJobDefinition.Builder	A fluent builder for EksJobDefinition.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IEksJobDefinition

IEksJobDefinition.Jsii$Default, IEksJobDefinition.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IJobDefinition

IJobDefinition.Jsii$Default, IJobDefinition.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EksJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EksJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)
	EksJobDefinition(software.constructs.Construct scope, String id, EksJobDefinitionProps props)

Method Summary

Modifier and Type	Method	Description
void	addRetryStrategy(RetryStrategy strategy)	Add a RetryStrategy to this JobDefinition.
static IEksJobDefinition	fromEksJobDefinitionArn(software.constructs.Construct scope, String id, String eksJobDefinitionArn)	Import an EksJobDefinition by its arn.
EksContainerDefinition	getContainer()	The container this Job Definition will run.
DnsPolicy	getDnsPolicy()	The DNS Policy of the pod used by this Job Definition.
String	getJobDefinitionArn()	The ARN of this job definition.
String	getJobDefinitionName()	The name of this job definition.
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.
Number	getRetryAttempts()	The number of times to retry a job.
List<RetryStrategy>	getRetryStrategies()	Defines the retry behavior for this job.
Number	getSchedulingPriority()	The priority of this Job.
String	getServiceAccount()	The name of the service account that's used to run the container.
Duration	getTimeout()	The timeout time for jobs that are submitted with this job definition.
Boolean	getUseHostNetwork()	If specified, the Pod used by this Job Definition will use the host's network IP address.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

EksJobDefinition

protected EksJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)

EksJobDefinition

protected EksJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

EksJobDefinition

@Stability(Stable)
public EksJobDefinition(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 EksJobDefinitionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromEksJobDefinitionArn

@Stability(Stable)
@NotNull
public static IEksJobDefinition fromEksJobDefinitionArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String eksJobDefinitionArn)

Import an EksJobDefinition by its arn.

Parameters:

scope - This parameter is required.

id - This parameter is required.

eksJobDefinitionArn - This parameter is required.

addRetryStrategy

@Stability(Stable)
public void addRetryStrategy(@NotNull
 RetryStrategy strategy)

Add a RetryStrategy to this JobDefinition.

Specified by:

addRetryStrategy in interface IJobDefinition

Parameters:

strategy - This parameter is required.

getContainer

@Stability(Stable)
@NotNull
public EksContainerDefinition getContainer()

The container this Job Definition will run.

Specified by:

getContainer in interface IEksJobDefinition

getJobDefinitionArn

@Stability(Stable)
@NotNull
public String getJobDefinitionArn()

The ARN of this job definition.

Specified by:

getJobDefinitionArn in interface IJobDefinition

getJobDefinitionName

@Stability(Stable)
@NotNull
public String getJobDefinitionName()

The name of this job definition.

Specified by:

getJobDefinitionName in interface IJobDefinition

getRetryStrategies

@Stability(Stable)
@NotNull
public List<RetryStrategy> getRetryStrategies()

Defines the retry behavior for this job.

Specified by:

getRetryStrategies in interface IJobDefinition

getDnsPolicy

@Stability(Stable)
@Nullable
public DnsPolicy getDnsPolicy()

The DNS Policy of the pod used by this Job Definition.

Specified by:

getDnsPolicy in interface IEksJobDefinition

See Also:

• https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy

getParameters

@Stability(Stable)
@Nullable
public 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.

Specified by:

getParameters in interface IJobDefinition

See Also:

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

getRetryAttempts

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

The number of times to retry a job.

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

Specified by:

getRetryAttempts in interface IJobDefinition

getSchedulingPriority

@Stability(Stable)
@Nullable
public 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.

Specified by:

getSchedulingPriority in interface IJobDefinition

getServiceAccount

@Stability(Stable)
@Nullable
public String getServiceAccount()

The name of the service account that's used to run the container.

service accounts are Kubernetes method of identification and authentication, roughly analogous to IAM users.

Specified by:

getServiceAccount in interface IEksJobDefinition

See Also:

• https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html

getTimeout

@Stability(Stable)
@Nullable
public 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.

Specified by:

getTimeout in interface IJobDefinition

getUseHostNetwork

@Stability(Stable)
@Nullable
public Boolean getUseHostNetwork()

If specified, the Pod used by this Job Definition will use the host's network IP address.

Otherwise, the Kubernetes pod networking model is enabled. Most AWS Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections.

Specified by:

getUseHostNetwork in interface IEksJobDefinition

See Also:

• https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking