Package software.amazon.awssdk.services.batch.model

Interface EksPodPropertiesDetail.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EksPodPropertiesDetail.Builder,EksPodPropertiesDetail>, SdkBuilder<EksPodPropertiesDetail.Builder,EksPodPropertiesDetail>, SdkPojo

Enclosing class:

EksPodPropertiesDetail

public static interface EksPodPropertiesDetail.Builder
extends SdkPojo, CopyableBuilder<EksPodPropertiesDetail.Builder,EksPodPropertiesDetail>

Method Summary

Modifier and Type	Method	Description
EksPodPropertiesDetail.Builder	containers(Collection<EksContainerDetail> containers)	The properties of the container that's used on the Amazon EKS pod.
EksPodPropertiesDetail.Builder	containers(Consumer<EksContainerDetail.Builder>... containers)	The properties of the container that's used on the Amazon EKS pod.
EksPodPropertiesDetail.Builder	containers(EksContainerDetail... containers)	The properties of the container that's used on the Amazon EKS pod.
EksPodPropertiesDetail.Builder	dnsPolicy(String dnsPolicy)	The DNS policy for the pod.
EksPodPropertiesDetail.Builder	hostNetwork(Boolean hostNetwork)	Indicates if the pod uses the hosts' network IP address.
EksPodPropertiesDetail.Builder	imagePullSecrets(Collection<ImagePullSecret> imagePullSecrets)	Displays the reference pointer to the Kubernetes secret resource.
EksPodPropertiesDetail.Builder	imagePullSecrets(Consumer<ImagePullSecret.Builder>... imagePullSecrets)	Displays the reference pointer to the Kubernetes secret resource.
EksPodPropertiesDetail.Builder	imagePullSecrets(ImagePullSecret... imagePullSecrets)	Displays the reference pointer to the Kubernetes secret resource.
EksPodPropertiesDetail.Builder	initContainers(Collection<EksContainerDetail> initContainers)	The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.
EksPodPropertiesDetail.Builder	initContainers(Consumer<EksContainerDetail.Builder>... initContainers)	The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.
EksPodPropertiesDetail.Builder	initContainers(EksContainerDetail... initContainers)	The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.
default EksPodPropertiesDetail.Builder	metadata(Consumer<EksMetadata.Builder> metadata)	Describes and uniquely identifies Kubernetes resources.
EksPodPropertiesDetail.Builder	metadata(EksMetadata metadata)	Describes and uniquely identifies Kubernetes resources.
EksPodPropertiesDetail.Builder	nodeName(String nodeName)	The name of the node for this job.
EksPodPropertiesDetail.Builder	podName(String podName)	The name of the pod for this job.
EksPodPropertiesDetail.Builder	serviceAccountName(String serviceAccountName)	The name of the service account that's used to run the pod.
EksPodPropertiesDetail.Builder	shareProcessNamespace(Boolean shareProcessNamespace)	Indicates if the processes in a container are shared, or visible, to other containers in the same pod.
EksPodPropertiesDetail.Builder	volumes(Collection<EksVolume> volumes)	Specifies the volumes for a job definition using Amazon EKS resources.
EksPodPropertiesDetail.Builder	volumes(Consumer<EksVolume.Builder>... volumes)	Specifies the volumes for a job definition using Amazon EKS resources.
EksPodPropertiesDetail.Builder	volumes(EksVolume... volumes)	Specifies the volumes for a job definition using Amazon EKS resources.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

serviceAccountName

EksPodPropertiesDetail.Builder serviceAccountName(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

hostNetwork

EksPodPropertiesDetail.Builder hostNetwork(Boolean 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 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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dnsPolicy

EksPodPropertiesDetail.Builder dnsPolicy(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

imagePullSecrets

EksPodPropertiesDetail.Builder imagePullSecrets(Collection<ImagePullSecret> imagePullSecrets)

Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain access to pull an images from a private registry.

Parameters:

imagePullSecrets - Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain access to pull an images from a private registry.

Returns:

Returns a reference to this object so that method calls can be chained together.

imagePullSecrets

EksPodPropertiesDetail.Builder imagePullSecrets(ImagePullSecret... imagePullSecrets)

Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain access to pull an images from a private registry.

Parameters:

imagePullSecrets - Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain access to pull an images from a private registry.

Returns:

Returns a reference to this object so that method calls can be chained together.

imagePullSecrets

EksPodPropertiesDetail.Builder imagePullSecrets(Consumer<ImagePullSecret.Builder>... imagePullSecrets)

Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain access to pull an images from a private registry.

This is a convenience method that creates an instance of the ImagePullSecret.Builder avoiding the need to create one manually via ImagePullSecret.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #imagePullSecrets(List).

Parameters:

imagePullSecrets - a consumer that will call methods on ImagePullSecret.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#imagePullSecrets(java.util.Collection)

containers

EksPodPropertiesDetail.Builder containers(Collection<EksContainerDetail> containers)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

containers

EksPodPropertiesDetail.Builder containers(EksContainerDetail... containers)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

containers

EksPodPropertiesDetail.Builder containers(Consumer<EksContainerDetail.Builder>... containers)

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

This is a convenience method that creates an instance of the EksContainerDetail.Builder avoiding the need to create one manually via EksContainerDetail.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #containers(List).

Parameters:

containers - a consumer that will call methods on EksContainerDetail.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#containers(java.util.Collection)

initContainers

EksPodPropertiesDetail.Builder initContainers(Collection<EksContainerDetail> initContainers)

The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.

Parameters:

initContainers - The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.

Returns:

Returns a reference to this object so that method calls can be chained together.

initContainers

EksPodPropertiesDetail.Builder initContainers(EksContainerDetail... initContainers)

The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.

Parameters:

initContainers - The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.

Returns:

Returns a reference to this object so that method calls can be chained together.

initContainers

EksPodPropertiesDetail.Builder initContainers(Consumer<EksContainerDetail.Builder>... initContainers)

The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.

This is a convenience method that creates an instance of the EksContainerDetail.Builder avoiding the need to create one manually via EksContainerDetail.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #initContainers(List).

Parameters:

initContainers - a consumer that will call methods on EksContainerDetail.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#initContainers(java.util.Collection)

volumes

EksPodPropertiesDetail.Builder volumes(Collection<EksVolume> volumes)

Specifies the volumes for a job definition using Amazon EKS resources.

Parameters:

volumes - Specifies the volumes for a job definition using Amazon EKS resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

volumes

EksPodPropertiesDetail.Builder volumes(EksVolume... volumes)

Specifies the volumes for a job definition using Amazon EKS resources.

Parameters:

volumes - Specifies the volumes for a job definition using Amazon EKS resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

volumes

EksPodPropertiesDetail.Builder volumes(Consumer<EksVolume.Builder>... volumes)

Specifies the volumes for a job definition using Amazon EKS resources.

This is a convenience method that creates an instance of the EksVolume.Builder avoiding the need to create one manually via EksVolume.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #volumes(List).

Parameters:

volumes - a consumer that will call methods on EksVolume.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#volumes(java.util.Collection)

podName

EksPodPropertiesDetail.Builder podName(String podName)

The name of the pod for this job.

Parameters:

podName - The name of the pod for this job.

Returns:

Returns a reference to this object so that method calls can be chained together.

nodeName

EksPodPropertiesDetail.Builder nodeName(String nodeName)

The name of the node for this job.

Parameters:

nodeName - The name of the node for this job.

Returns:

Returns a reference to this object so that method calls can be chained together.

metadata

EksPodPropertiesDetail.Builder metadata(EksMetadata metadata)

Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the jobID for a job running in the pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

Parameters:

metadata - Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the jobID for a job running in the pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

Returns:

Returns a reference to this object so that method calls can be chained together.

metadata

default EksPodPropertiesDetail.Builder metadata(Consumer<EksMetadata.Builder> metadata)

Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the jobID for a job running in the pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

This is a convenience method that creates an instance of the EksMetadata.Builder avoiding the need to create one manually via EksMetadata.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadata(EksMetadata).

Parameters:

metadata - a consumer that will call methods on EksMetadata.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

metadata(EksMetadata)

shareProcessNamespace

EksPodPropertiesDetail.Builder shareProcessNamespace(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.