software.amazon.awssdk.services.batch.model

Interface EksContainer.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EksContainer.Builder,EksContainer>, SdkBuilder<EksContainer.Builder,EksContainer>, SdkPojo

Enclosing class:

EksContainer

public static interface EksContainer.Builder
extends SdkPojo, CopyableBuilder<EksContainer.Builder,EksContainer>

Method Summary

Modifier and Type	Method and Description
EksContainer.Builder	args(Collection<String> args) An array of arguments to the entrypoint.
EksContainer.Builder	args(String... args) An array of arguments to the entrypoint.
EksContainer.Builder	command(Collection<String> command) The entrypoint for the container.
EksContainer.Builder	command(String... command) The entrypoint for the container.
EksContainer.Builder	env(Collection<EksContainerEnvironmentVariable> env) The environment variables to pass to a container.
EksContainer.Builder	env(Consumer<EksContainerEnvironmentVariable.Builder>... env) The environment variables to pass to a container.
EksContainer.Builder	env(EksContainerEnvironmentVariable... env) The environment variables to pass to a container.
EksContainer.Builder	image(String image) The Docker image used to start the container.
EksContainer.Builder	imagePullPolicy(String imagePullPolicy) The image pull policy for the container.
EksContainer.Builder	name(String name) The name of the container.
default EksContainer.Builder	resources(Consumer<EksContainerResourceRequirements.Builder> resources) The type and amount of resources to assign to a container.
EksContainer.Builder	resources(EksContainerResourceRequirements resources) The type and amount of resources to assign to a container.
default EksContainer.Builder	securityContext(Consumer<EksContainerSecurityContext.Builder> securityContext) The security context for a job.
EksContainer.Builder	securityContext(EksContainerSecurityContext securityContext) The security context for a job.
EksContainer.Builder	volumeMounts(Collection<EksContainerVolumeMount> volumeMounts) The volume mounts for the container.
EksContainer.Builder	volumeMounts(Consumer<EksContainerVolumeMount.Builder>... volumeMounts) The volume mounts for the container.
EksContainer.Builder	volumeMounts(EksContainerVolumeMount... volumeMounts) The volume mounts for the container.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

EksContainer.Builder name(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

image

EksContainer.Builder image(String image)

The Docker image used to start the container.

Parameters:

image - The Docker image used to start the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

imagePullPolicy

EksContainer.Builder imagePullPolicy(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

command

EksContainer.Builder command(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

command

EksContainer.Builder command(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

args

EksContainer.Builder args(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

args

EksContainer.Builder args(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

env

EksContainer.Builder env(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

env

EksContainer.Builder env(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

env

EksContainer.Builder env(Consumer<EksContainerEnvironmentVariable.Builder>... 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.

This is a convenience method that creates an instance of the EksContainerEnvironmentVariable.Builder avoiding the need to create one manually via EksContainerEnvironmentVariable.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #env(List).

Parameters:

env - a consumer that will call methods on EksContainerEnvironmentVariable.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#env(java.util.Collection)

resources

EksContainer.Builder resources(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

resources

default EksContainer.Builder resources(Consumer<EksContainerResourceRequirements.Builder> 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.

This is a convenience method that creates an instance of the EksContainerResourceRequirements.Builder avoiding the need to create one manually via EksContainerResourceRequirements.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resources(EksContainerResourceRequirements).

Parameters:

resources - a consumer that will call methods on EksContainerResourceRequirements.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

resources(EksContainerResourceRequirements)

volumeMounts

EksContainer.Builder volumeMounts(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

volumeMounts

EksContainer.Builder volumeMounts(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

volumeMounts

EksContainer.Builder volumeMounts(Consumer<EksContainerVolumeMount.Builder>... 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.

This is a convenience method that creates an instance of the EksContainerVolumeMount.Builder avoiding the need to create one manually via EksContainerVolumeMount.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #volumeMounts(List).

Parameters:

volumeMounts - a consumer that will call methods on EksContainerVolumeMount.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#volumeMounts(java.util.Collection)

securityContext

EksContainer.Builder securityContext(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

securityContext

default EksContainer.Builder securityContext(Consumer<EksContainerSecurityContext.Builder> securityContext)

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

This is a convenience method that creates an instance of the EksContainerSecurityContext.Builder avoiding the need to create one manually via EksContainerSecurityContext.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to securityContext(EksContainerSecurityContext).

Parameters:

securityContext - a consumer that will call methods on EksContainerSecurityContext.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

securityContext(EksContainerSecurityContext)