software.amazon.awssdk.services.batch.model

Interface EksPodProperties.Builder

All Superinterfaces:

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

Enclosing class:

EksPodProperties

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

Method Summary

Modifier and Type	Method and Description
EksPodProperties.Builder	containers(Collection<EksContainer> containers) The properties of the container that's used on the Amazon EKS pod.
EksPodProperties.Builder	containers(Consumer<EksContainer.Builder>... containers) The properties of the container that's used on the Amazon EKS pod.
EksPodProperties.Builder	containers(EksContainer... containers) The properties of the container that's used on the Amazon EKS pod.
EksPodProperties.Builder	dnsPolicy(String dnsPolicy) The DNS policy for the pod.
EksPodProperties.Builder	hostNetwork(Boolean hostNetwork) Indicates if the pod uses the hosts' network IP address.
default EksPodProperties.Builder	metadata(Consumer<EksMetadata.Builder> metadata) Metadata about the Kubernetes pod.
EksPodProperties.Builder	metadata(EksMetadata metadata) Metadata about the Kubernetes pod.
EksPodProperties.Builder	serviceAccountName(String serviceAccountName) The name of the service account that's used to run the pod.
EksPodProperties.Builder	volumes(Collection<EksVolume> volumes) Specifies the volumes for a job definition that uses Amazon EKS resources.
EksPodProperties.Builder	volumes(Consumer<EksVolume.Builder>... volumes) Specifies the volumes for a job definition that uses Amazon EKS resources.
EksPodProperties.Builder	volumes(EksVolume... volumes) Specifies the volumes for a job definition that uses Amazon EKS resources.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

serviceAccountName

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

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.

containers

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

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

EksPodProperties.Builder containers(Consumer<EksContainer.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 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 #containers(List).

Parameters:

containers - 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:

#containers(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.

volumes

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

Specifies the volumes for a job definition that uses 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)

metadata

EksPodProperties.Builder metadata(EksMetadata metadata)

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

Parameters:

metadata - Metadata about the Kubernetes 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 EksPodProperties.Builder metadata(Consumer<EksMetadata.Builder> metadata)

Metadata about the Kubernetes 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)