Class EksPodProperties
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EksPodProperties.Builder,
EksPodProperties>
The properties for the pod.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EksPodProperties.Builder
builder()
final List
<EksContainer> The properties of the container that's used on the Amazon EKS pod.final String
The DNS policy for the pod.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Containers property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ImagePullSecrets property.final boolean
For responses, this returns true if the service returned a value for the InitContainers property.final boolean
For responses, this returns true if the service returned a value for the Volumes property.final Boolean
Indicates if the pod uses the hosts' network IP address.final List
<ImagePullSecret> References a Kubernetes secret resource.final List
<EksContainer> These containers run before application containers, always runs to completion, and must complete successfully before the next container starts.final EksMetadata
metadata()
Metadata about the Kubernetes pod.static Class
<? extends EksPodProperties.Builder> final String
The name of the service account that's used to run the pod.final Boolean
Indicates if the processes in a container are shared, or visible, to other containers in the same pod.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.volumes()
Specifies the volumes for a job definition that uses Amazon EKS resources.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Indicates if the pod uses the hosts' network IP address. The default value is
true
. Setting this tofalse
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 tofalse
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
The DNS policy for the pod. The default value is
ClusterFirst
. If thehostNetwork
parameter is not specified, the default isClusterFirstWithHostNet
.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 thehostNetwork
parameter is not specified, the default isClusterFirstWithHostNet
.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
-
hasImagePullSecrets
public final boolean hasImagePullSecrets()For responses, this returns true if the service returned a value for the ImagePullSecrets property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.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
hasImagePullSecrets()
method.- 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.
-
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 theisEmpty()
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
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.
-
hasInitContainers
public final boolean hasInitContainers()For responses, this returns true if the service returned a value for the InitContainers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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
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
hasInitContainers()
method.- 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
-
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 theisEmpty()
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<EksPodProperties.Builder,
EksPodProperties> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-