EksPodProperties - Amazon Batch
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

EksPodProperties

The properties for the pod.

Contents

containers

The properties of the container that's used on the Amazon EKS pod.

Note

This object is limited to 10 elements.

Type: Array of EksContainer objects

Required: No

dnsPolicy

The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

Type: String

Required: No

hostNetwork

Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to false enables the Kubernetes pod networking model. Most Amazon Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.

Type: Boolean

Required: No

imagePullSecrets

References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain access to pull an images from a private registry.

ImagePullSecret$name is required when this object is used.

Type: Array of ImagePullSecret objects

Required: No

initContainers

These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init Containers in the Kubernetes documentation.

Note

This object is limited to 10 elements.

Type: Array of EksContainer objects

Required: No

metadata

Metadata about the Kubernetes pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

Type: EksMetadata object

Required: No

serviceAccountName

The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation.

Type: String

Required: No

shareProcessNamespace

Indicates if the processes in a container are shared, or visible, to other containers in the same pod. For more information, see Share Process Namespace between Containers in a Pod.

Type: Boolean

Required: No

volumes

Specifies the volumes for a job definition that uses Amazon EKS resources.

Type: Array of EksVolume objects

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: