software.amazon.awssdk.services.batch.model

Class EksPodProperties

java.lang.Object

software.amazon.awssdk.services.batch.model.EksPodProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EksPodProperties.Builder,EksPodProperties>

@Generated(value="software.amazon.awssdk:codegen")
public final class EksPodProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EksPodProperties.Builder,EksPodProperties>

The properties for the pod.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EksPodProperties.Builder

Method Summary

Modifier and Type	Method and Description
static EksPodProperties.Builder	builder()
List<EksContainer>	containers() The properties of the container that's used on the Amazon EKS pod.
String	dnsPolicy() The DNS policy for the pod.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContainers() For responses, this returns true if the service returned a value for the Containers property.
int	hashCode()
boolean	hasVolumes() For responses, this returns true if the service returned a value for the Volumes property.
Boolean	hostNetwork() Indicates if the pod uses the hosts' network IP address.
EksMetadata	metadata() Metadata about the Kubernetes pod.
List<SdkField<?>>	sdkFields()
static Class<? extends EksPodProperties.Builder>	serializableBuilderClass()
String	serviceAccountName() The name of the service account that's used to run the pod.
EksPodProperties.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<EksVolume>	volumes() Specifies the volumes for a job definition that uses Amazon EKS resources.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

serviceAccountName

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

Returns:

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.

hostNetwork

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

Returns:

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.

dnsPolicy

public final 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

Returns:

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

hasContainers

public final boolean hasContainers()

For responses, this returns true if the service returned a value for the Containers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

containers

public final List<EksContainer> containers()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContainers() method.

Returns:

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

hasVolumes

public final boolean hasVolumes()

For responses, this returns true if the service returned a value for the Volumes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

volumes

public final List<EksVolume> volumes()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVolumes() method.

Returns:

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

metadata

public final EksMetadata metadata()

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

Returns:

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

toBuilder

public EksPodProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EksPodProperties.Builder,EksPodProperties>

builder

public static EksPodProperties.Builder builder()

serializableBuilderClass

public static Class<? extends EksPodProperties.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo