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

Interface EksPodProperties.Builder

    • Method Detail

      • hostNetwork

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

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

        EksPodProperties.Builder imagePullSecrets​(Collection<ImagePullSecret> 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.

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

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

      • imagePullSecrets

        EksPodProperties.Builder imagePullSecrets​(ImagePullSecret... 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.

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

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

      • imagePullSecrets

        EksPodProperties.Builder imagePullSecrets​(Consumer<ImagePullSecret.Builder>... 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.

        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

        EksPodProperties.Builder containers​(Collection<EksContainer> containers)

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

        This object is limited to 10 elements.

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

        This object is limited to 10 elements.

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

      • containers

        EksPodProperties.Builder containers​(EksContainer... containers)

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

        This object is limited to 10 elements.

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

        This object is limited to 10 elements.

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

      • initContainers

        EksPodProperties.Builder initContainers​(Collection<EksContainer> 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.

        This object is limited to 10 elements.

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

        This object is limited to 10 elements.

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

      • initContainers

        EksPodProperties.Builder initContainers​(EksContainer... 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.

        This object is limited to 10 elements.

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

        This object is limited to 10 elements.

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

      • initContainers

        EksPodProperties.Builder initContainers​(Consumer<EksContainer.Builder>... 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.

        This object is limited to 10 elements.

        This is a convenience method that creates an instance of the EksContainer.Builder avoiding the need to create one manually via EksContainer.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 EksContainer.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #initContainers(java.util.Collection)

      • volumes

        EksPodProperties.Builder volumes​(Collection<EksVolume> volumes)

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

        Parameters:
        volumes - Specifies the volumes for a job definition that uses Amazon EKS resources.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • volumes

        EksPodProperties.Builder volumes​(EksVolume... volumes)

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

        Parameters:
        volumes - Specifies the volumes for a job definition that uses Amazon EKS resources.
        Returns:
        Returns a reference to this object so that method calls can be chained together.