@aws-cdk_aws-batch-alpha.EksJobDefinitionProps

interface EksJobDefinitionProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.EksJobDefinitionProps
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#EksJobDefinitionProps
Javasoftware.amazon.awscdk.services.batch.alpha.EksJobDefinitionProps
Pythonaws_cdk.aws_batch_alpha.EksJobDefinitionProps
TypeScript (source)@aws-cdk/aws-batch-alpha ยป EksJobDefinitionProps

Props for EksJobDefinition.

Example

import * as cdk from 'aws-cdk-lib';
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

NameTypeDescription
container๐Ÿ”นEksContainerDefinitionThe container this Job Definition will run.
dnsPolicy?๐Ÿ”นDnsPolicyThe DNS Policy of the pod used by this Job Definition.
jobDefinitionName?๐Ÿ”นstringThe name of 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?๐Ÿ”นnumberThe number of times to retry a job.
retryStrategies?๐Ÿ”นRetryStrategy[]Defines the retry behavior for this job.
schedulingPriority?๐Ÿ”นnumberThe priority of this Job.
serviceAccount?๐Ÿ”นstringThe name of the service account that's used to run the container.
timeout?๐Ÿ”นDurationThe timeout time for jobs that are submitted with this job definition.
useHostNetwork?๐Ÿ”นbooleanIf 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.


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


jobDefinitionName?๐Ÿ”น

Type: string (optional, default: generated by CloudFormation)

The name of this job definition.


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.


retryStrategies?๐Ÿ”น

Type: RetryStrategy[] (optional, default: no RetryStrategy)

Defines the retry behavior for this job.


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