AWS::Batch::JobDefinition PodProperties - Amazon CloudFormation
SyntaxProperties
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).

AWS::Batch::JobDefinition PodProperties

The properties for the pod.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Containers" : [ EksContainer, ... ],
  "DnsPolicy" : String,
  "HostNetwork" : Boolean,
  "Metadata" : Metadata,
  "ServiceAccountName" : String,
  "Volumes" : [ EksVolume, ... ]
}

Properties

Containers

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

Required: No

Type: List of EksContainer

Update requires: No interruption

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. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The pod spec setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending on the value of the hostNetwork parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

Metadata

Property description not available.

Required: No

Type: Metadata

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

Volumes

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

Required: No

Type: List of EksVolume

Update requires: No interruption