EksPodProperties (AWS SDK for Java

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()

Constructors
Constructor and Description
`EksPodProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`EksMetadata`	`getMetadata()` Metadata about the Kubernetes pod.
`String`	`getServiceAccountName()` The name of the service account that's used to run the 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.
`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`	`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`	`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`	`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`	`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.
  - 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.
  - 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.
  - 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.

AWS SDK for Java 1.x API Reference - 1.12.560

Class EksPodProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EksPodProperties

Method Detail

setServiceAccountName

getServiceAccountName

withServiceAccountName

setHostNetwork

getHostNetwork

withHostNetwork

isHostNetwork

setDnsPolicy

getDnsPolicy

withDnsPolicy

getContainers

setContainers

withContainers

withContainers

getVolumes

setVolumes

withVolumes

withVolumes

setMetadata

getMetadata

withMetadata

toString

equals

hashCode

clone

marshall