interface IEksJobDefinition

Language	Type name
.NET	Amazon.CDK.AWS.Batch.IEksJobDefinition
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#IEksJobDefinition
Java	software.amazon.awscdk.services.batch.IEksJobDefinition
Python	aws_cdk.aws_batch.IEksJobDefinition
TypeScript (source)	aws-cdk-lib » aws_batch » IEksJobDefinition

Implemented by EksJobDefinition

Obtainable from EksJobDefinition.fromEksJobDefinitionArn()

A JobDefinition that uses Eks orchestration.

Properties

Name	Type	Description
container	EksContainerDefinition	The container this Job Definition will run.
env	ResourceEnvironment	The environment this resource belongs to.
jobDefinitionArn	string	The ARN of this job definition.
jobDefinitionName	string	The name of this job definition.
node	Node	The tree node.
retryStrategies	RetryStrategy[]	Defines the retry behavior for this job.
stack	Stack	The stack in which this resource is defined.
dnsPolicy?	DnsPolicy	The DNS Policy of the pod used by this Job Definition.
parameters?	{ [string]: any }	The default parameters passed to the container These parameters can be referenced in the command that you give to the container.
retryAttempts?	number	The number of times to retry a job.
schedulingPriority?	number	The priority of this Job.
serviceAccount?	string	The name of the service account that's used to run the container.
timeout?	Duration	The timeout time for jobs that are submitted with this job definition.
useHostNetwork?	boolean	If specified, the Pod used by this Job Definition will use the host's network IP address.

---

container

Type: EksContainerDefinition

The container this Job Definition will run.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

jobDefinitionArn

Type: string

The ARN of this job definition.

---

jobDefinitionName

Type: string

The name of this job definition.

---

node

Type: Node

The tree node.

---

retryStrategies

Type: RetryStrategy[]

Defines the retry behavior for this job.

---

stack

Type: Stack

The stack in which this resource is defined.

---

dnsPolicy?

Type: DnsPolicy (optional, default: DnsPolicy.CLUSTER_FIRST)

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

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

---

parameters?

Type: { [string]: any } (optional, default: none)

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

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

---

retryAttempts?

Type: number (optional, default: 1)

The number of times to retry a job.

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

---

schedulingPriority?

Type: number (optional, default: none)

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.

---

serviceAccount?

Type: string (optional, default: the default service account of the container)

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.

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

---

timeout?

Type: Duration (optional, default: no timeout)

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.

---

useHostNetwork?

Type: boolean (optional, default: true)

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.

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

Methods

Name	Description
addRetryStrategy(strategy)	Add a RetryStrategy to this JobDefinition.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

addRetryStrategy(strategy)

public addRetryStrategy(strategy: RetryStrategy): void

Parameters

• strategy RetryStrategy

Add a RetryStrategy to this JobDefinition.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).