software.amazon.awssdk.services.batch.model

Class EksContainer

java.lang.Object

software.amazon.awssdk.services.batch.model.EksContainer

All Implemented Interfaces:

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

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

EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job definitions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EksContainer.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	args() An array of arguments to the entrypoint.
static EksContainer.Builder	builder()
List<String>	command() The entrypoint for the container.
List<EksContainerEnvironmentVariable>	env() The environment variables to pass to a container.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasArgs() For responses, this returns true if the service returned a value for the Args property.
boolean	hasCommand() For responses, this returns true if the service returned a value for the Command property.
boolean	hasEnv() For responses, this returns true if the service returned a value for the Env property.
int	hashCode()
boolean	hasVolumeMounts() For responses, this returns true if the service returned a value for the VolumeMounts property.
String	image() The Docker image used to start the container.
String	imagePullPolicy() The image pull policy for the container.
String	name() The name of the container.
EksContainerResourceRequirements	resources() The type and amount of resources to assign to a container.
List<SdkField<?>>	sdkFields()
EksContainerSecurityContext	securityContext() The security context for a job.
static Class<? extends EksContainer.Builder>	serializableBuilderClass()
EksContainer.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<EksContainerVolumeMount>	volumeMounts() The volume mounts for the container.

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

name

public final String name()

The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

Returns:

The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

image

public final String image()

The Docker image used to start the container.

Returns:

The Docker image used to start the container.

imagePullPolicy

public final String imagePullPolicy()

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.

Returns:

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.

hasCommand

public final boolean hasCommand()

For responses, this returns true if the service returned a value for the Command 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.

command

public final List<String> command()

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can't be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.

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 hasCommand() method.

Returns:

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can't be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.

hasArgs

public final boolean hasArgs()

For responses, this returns true if the service returned a value for the Args 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.

args

public final List<String> args()

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $, and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile reference and Define a command and arguments for a pod in the Kubernetes documentation.

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 hasArgs() method.

Returns:

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $, and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile reference and Define a command and arguments for a pod in the Kubernetes documentation.

hasEnv

public final boolean hasEnv()

For responses, this returns true if the service returned a value for the Env 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.

env

public final List<EksContainerEnvironmentVariable> env()

The environment variables to pass to a container.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

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 hasEnv() method.

Returns:

The environment variables to pass to a container.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

resources

public final EksContainerResourceRequirements resources()

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

Returns:

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

hasVolumeMounts

public final boolean hasVolumeMounts()

For responses, this returns true if the service returned a value for the VolumeMounts 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.

volumeMounts

public final List<EksContainerVolumeMount> volumeMounts()

The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

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 hasVolumeMounts() method.

Returns:

The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

securityContext

public final EksContainerSecurityContext securityContext()

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

Returns:

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

toBuilder

public EksContainer.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EksContainer.Builder,EksContainer>

builder

public static EksContainer.Builder builder()

serializableBuilderClass

public static Class<? extends EksContainer.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