Package software.amazon.awscdk.services.batch

Interface EksJobDefinitionProps

All Superinterfaces:

JobDefinitionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EksJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:55.420Z")
@Stability(Stable)
public interface EksJobDefinitionProps
extends software.amazon.jsii.JsiiSerializable, JobDefinitionProps

Props for EksJobDefinition.

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	Interface	Description
static final class	EksJobDefinitionProps.Builder	A builder for EksJobDefinitionProps
static final class	EksJobDefinitionProps.Jsii$Proxy	An implementation for EksJobDefinitionProps

Method Summary

Modifier and Type	Method	Description
static EksJobDefinitionProps.Builder	builder()
EksContainerDefinition	getContainer()	The container this Job Definition will run.
default DnsPolicy	getDnsPolicy()	The DNS Policy of the pod used by this Job Definition.
default String	getServiceAccount()	The name of the service account that's used to run the container.
default Boolean	getUseHostNetwork()	If specified, the Pod used by this Job Definition will use the host's network IP address.

Methods inherited from interface software.amazon.awscdk.services.batch.JobDefinitionProps

getJobDefinitionName, getParameters, getRetryAttempts, getRetryStrategies, getSchedulingPriority, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainer

@Stability(Stable)
@NotNull
EksContainerDefinition getContainer()

The container this Job Definition will run.

getDnsPolicy

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

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

Default: `DnsPolicy.CLUSTER_FIRST`

See Also:

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

getServiceAccount

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

Default: - the default service account of the container

See Also:

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

getUseHostNetwork

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

Default: true

See Also:

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

builder

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

Returns:

a EksJobDefinitionProps.Builder of EksJobDefinitionProps