com.amazonaws.services.batch.model

Class EksPodProperties

java.lang.Object

com.amazonaws.services.batch.model.EksPodProperties

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EksPodProperties
extends Object
implements Serializable, Cloneable, StructuredPojo

The properties for the pod.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EksPodProperties()

Method Summary

Modifier and Type	Method and Description
EksPodProperties	clone()
boolean	equals(Object obj)
List<EksContainer>	getContainers() The properties of the container that's used on the Amazon EKS pod.
String	getDnsPolicy() The DNS policy for the pod.
Boolean	getHostNetwork() Indicates if the pod uses the hosts' network IP address.
List<ImagePullSecret>	getImagePullSecrets() References a Kubernetes secret resource.
List<EksContainer>	getInitContainers() These containers run before application containers, always runs to completion, and must complete successfully before the next container starts.
EksMetadata	getMetadata() Metadata about the Kubernetes pod.
String	getServiceAccountName() The name of the service account that's used to run the pod.
Boolean	getShareProcessNamespace() Indicates if the processes in a container are shared, or visible, to other containers in the same pod.
List<EksVolume>	getVolumes() Specifies the volumes for a job definition that uses Amazon EKS resources.
int	hashCode()
Boolean	isHostNetwork() Indicates if the pod uses the hosts' network IP address.
Boolean	isShareProcessNamespace() Indicates if the processes in a container are shared, or visible, to other containers in the same pod.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setContainers(Collection<EksContainer> containers) The properties of the container that's used on the Amazon EKS pod.
void	setDnsPolicy(String dnsPolicy) The DNS policy for the pod.
void	setHostNetwork(Boolean hostNetwork) Indicates if the pod uses the hosts' network IP address.
void	setImagePullSecrets(Collection<ImagePullSecret> imagePullSecrets) References a Kubernetes secret resource.
void	setInitContainers(Collection<EksContainer> initContainers) These containers run before application containers, always runs to completion, and must complete successfully before the next container starts.
void	setMetadata(EksMetadata metadata) Metadata about the Kubernetes pod.
void	setServiceAccountName(String serviceAccountName) The name of the service account that's used to run the pod.
void	setShareProcessNamespace(Boolean shareProcessNamespace) Indicates if the processes in a container are shared, or visible, to other containers in the same pod.
void	setVolumes(Collection<EksVolume> volumes) Specifies the volumes for a job definition that uses Amazon EKS resources.
String	toString() Returns a string representation of this object.
EksPodProperties	withContainers(Collection<EksContainer> containers) The properties of the container that's used on the Amazon EKS pod.
EksPodProperties	withContainers(EksContainer... containers) The properties of the container that's used on the Amazon EKS pod.
EksPodProperties	withDnsPolicy(String dnsPolicy) The DNS policy for the pod.
EksPodProperties	withHostNetwork(Boolean hostNetwork) Indicates if the pod uses the hosts' network IP address.
EksPodProperties	withImagePullSecrets(Collection<ImagePullSecret> imagePullSecrets) References a Kubernetes secret resource.
EksPodProperties	withImagePullSecrets(ImagePullSecret... imagePullSecrets) References a Kubernetes secret resource.
EksPodProperties	withInitContainers(Collection<EksContainer> initContainers) These containers run before application containers, always runs to completion, and must complete successfully before the next container starts.
EksPodProperties	withInitContainers(EksContainer... initContainers) These containers run before application containers, always runs to completion, and must complete successfully before the next container starts.
EksPodProperties	withMetadata(EksMetadata metadata) Metadata about the Kubernetes pod.
EksPodProperties	withServiceAccountName(String serviceAccountName) The name of the service account that's used to run the pod.
EksPodProperties	withShareProcessNamespace(Boolean shareProcessNamespace) Indicates if the processes in a container are shared, or visible, to other containers in the same pod.
EksPodProperties	withVolumes(Collection<EksVolume> volumes) Specifies the volumes for a job definition that uses Amazon EKS resources.
EksPodProperties	withVolumes(EksVolume... volumes) Specifies the volumes for a job definition that uses Amazon EKS resources.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EksPodProperties

public EksPodProperties()

Method Detail

setServiceAccountName

public void setServiceAccountName(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.

getServiceAccountName

public String getServiceAccountName()

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.

withServiceAccountName

public EksPodProperties withServiceAccountName(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.

setHostNetwork

public void setHostNetwork(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.

getHostNetwork

public Boolean getHostNetwork()

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.

withHostNetwork

public EksPodProperties withHostNetwork(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.

isHostNetwork

public Boolean isHostNetwork()

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.

setDnsPolicy

public void setDnsPolicy(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

getDnsPolicy

public String getDnsPolicy()

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

withDnsPolicy

public EksPodProperties withDnsPolicy(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.

getImagePullSecrets

public List<ImagePullSecret> getImagePullSecrets()

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:

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.

setImagePullSecrets

public void setImagePullSecrets(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.

withImagePullSecrets

public EksPodProperties withImagePullSecrets(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.

NOTE: This method appends the values to the existing list (if any). Use setImagePullSecrets(java.util.Collection) or withImagePullSecrets(java.util.Collection) if you want to override the existing values.

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.

withImagePullSecrets

public EksPodProperties withImagePullSecrets(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.

getContainers

public List<EksContainer> getContainers()

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

Returns:

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

setContainers

public void setContainers(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.

withContainers

public EksPodProperties withContainers(EksContainer... containers)

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

NOTE: This method appends the values to the existing list (if any). Use setContainers(java.util.Collection) or withContainers(java.util.Collection) if you want to override the existing values.

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.

withContainers

public EksPodProperties withContainers(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.

getInitContainers

public List<EksContainer> getInitContainers()

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:

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

setInitContainers

public void setInitContainers(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

withInitContainers

public EksPodProperties withInitContainers(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

NOTE: This method appends the values to the existing list (if any). Use setInitContainers(java.util.Collection) or withInitContainers(java.util.Collection) if you want to override the existing values.

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.

withInitContainers

public EksPodProperties withInitContainers(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.

getVolumes

public List<EksVolume> getVolumes()

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

Returns:

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

setVolumes

public void setVolumes(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.

withVolumes

public EksPodProperties withVolumes(EksVolume... volumes)

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

NOTE: This method appends the values to the existing list (if any). Use setVolumes(java.util.Collection) or withVolumes(java.util.Collection) if you want to override the existing values.

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.

withVolumes

public EksPodProperties withVolumes(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.

setMetadata

public void setMetadata(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.

getMetadata

public EksMetadata getMetadata()

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.

withMetadata

public EksPodProperties withMetadata(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.

setShareProcessNamespace

public void setShareProcessNamespace(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.

getShareProcessNamespace

public Boolean getShareProcessNamespace()

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:

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.

withShareProcessNamespace

public EksPodProperties withShareProcessNamespace(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.

isShareProcessNamespace

public Boolean isShareProcessNamespace()

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:

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EksPodProperties clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.