AWS CDK Reference

Appearance

v2.274.0

EksJobDefinitionProps Struct ​

Props for EksJobDefinition.

Source
aws-batch/lib/eks-job-definition.ts
Type last changed
v2.96.0 · 13 Sep 2023

Example ​

ts
const jobDefn = new batch.EksJobDefinition(this, 'eksf2', {
  container: new batch.EksContainerDefinition(this, 'container', {
    image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
    volumes: [batch.EksVolume.emptyDir({
      name: 'myEmptyDirVolume',
      mountPath: '/mount/path',
      medium: batch.EmptyDirMediumType.MEMORY,
      readonly: true,
      sizeLimit: cdk.Size.mebibytes(2048),
    })],
  }),
});

Properties ​

containerEksContainerDefinitioncontainerEksContainerDefinitioncontainerEksContainerDefinitionContainerEksContainerDefinitionContainerEksContainerDefinitionrequired#
The container this Job Definition will run.
dnsPolicyDnsPolicydns_policyDnsPolicydnsPolicyDnsPolicyDnsPolicyDnsPolicyDnsPolicyDnsPolicy= `DnsPolicy.CLUSTER_FIRST`#
The DNS Policy of the pod used by this Job Definition.
jobDefinitionNamestringjob_definition_namestrjobDefinitionNameStringJobDefinitionNamestringJobDefinitionName*string= generated by CloudFormation#
The name of this job definition.
parameters{ [key: string]: any }parameterstyping.Mapping[str, Any]parametersMap<String, Object>ParametersIDictionary<string, object>Parameters*map[string]interface{}= none#
The default parameters passed to the container These parameters can be referenced in the `command` that you give to the container.
retryAttemptsnumberretry_attemptsint | floatretryAttemptsNumberRetryAttemptsdoubleRetryAttempts*float64= 1#
The number of times to retry a job.

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

retryStrategiesRetryStrategy[]retry_strategiestyping.List[RetryStrategy]retryStrategiesList<RetryStrategy>RetryStrategiesRetryStrategy[]RetryStrategies*[]RetryStrategy= no `RetryStrategy`#
Defines the retry behavior for this job.
schedulingPrioritynumberscheduling_priorityint | floatschedulingPriorityNumberSchedulingPrioritydoubleSchedulingPriority*float64= 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.

serviceAccountstringservice_accountstrserviceAccountStringServiceAccountstringServiceAccount*string= the default service account of t…#
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.

default

Default: the default service account of the container

skipDeregisterOnUpdatebooleanskip_deregister_on_updateboolskipDeregisterOnUpdateBooleanSkipDeregisterOnUpdateboolSkipDeregisterOnUpdate*bool= undefined - AWS Batch default is…#
Specifies whether the previous revision of the job definition is retained in an active status after UPDATE events for the resource.

When the property is set to false, the previous revision of the job definition is de-registered after a new revision is created. When the property is set to true, the previous revision of the job definition is not de-registered.

default

Default: undefined - AWS Batch default is false

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= 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.

useHostNetworkbooleanuse_host_networkbooluseHostNetworkBooleanUseHostNetworkboolUseHostNetwork*bool= 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.