EksContainerDetail.Builder (AWS Java SDK :: Services

All Superinterfaces:

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

Enclosing class:

EksContainerDetail
```
public static interface EksContainerDetail.Builder
extends SdkPojo, CopyableBuilder<EksContainerDetail.Builder,EksContainerDetail>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`EksContainerDetail.Builder`	`args(Collection<String> args)` An array of arguments to the entrypoint.
`EksContainerDetail.Builder`	`args(String... args)` An array of arguments to the entrypoint.
`EksContainerDetail.Builder`	`command(Collection<String> command)` The entrypoint for the container.
`EksContainerDetail.Builder`	`command(String... command)` The entrypoint for the container.
`EksContainerDetail.Builder`	`env(Collection<EksContainerEnvironmentVariable> env)` The environment variables to pass to a container.
`EksContainerDetail.Builder`	`env(Consumer<EksContainerEnvironmentVariable.Builder>... env)` The environment variables to pass to a container.
`EksContainerDetail.Builder`	`env(EksContainerEnvironmentVariable... env)` The environment variables to pass to a container.
`EksContainerDetail.Builder`	`exitCode(Integer exitCode)` The exit code for the job attempt.
`EksContainerDetail.Builder`	`image(String image)` The Docker image used to start the container.
`EksContainerDetail.Builder`	`imagePullPolicy(String imagePullPolicy)` The image pull policy for the container.
`EksContainerDetail.Builder`	`name(String name)` The name of the container.
`EksContainerDetail.Builder`	`reason(String reason)` A short human-readable string to provide additional details for a running or stopped container.
`default EksContainerDetail.Builder`	`resources(Consumer<EksContainerResourceRequirements.Builder> resources)` The type and amount of resources to assign to a container.
`EksContainerDetail.Builder`	`resources(EksContainerResourceRequirements resources)` The type and amount of resources to assign to a container.
`default EksContainerDetail.Builder`	`securityContext(Consumer<EksContainerSecurityContext.Builder> securityContext)` The security context for a job.
`EksContainerDetail.Builder`	`securityContext(EksContainerSecurityContext securityContext)` The security context for a job.
`EksContainerDetail.Builder`	`volumeMounts(Collection<EksContainerVolumeMount> volumeMounts)` The volume mounts for the container.
`EksContainerDetail.Builder`	`volumeMounts(Consumer<EksContainerVolumeMount.Builder>... volumeMounts)` The volume mounts for the container.
`EksContainerDetail.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
```
EksContainerDetail.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
```
EksContainerDetail.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
```
EksContainerDetail.Builder imagePullPolicy(String imagePullPolicy)
```
    The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. 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 Always if the :latest tag is specified, IfNotPresent otherwise. 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
```
EksContainerDetail.Builder command(Collection<String> command)
```
    The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
    
    Parameters:
    
    command - The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - command
```
EksContainerDetail.Builder command(String... command)
```
    The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
    
    Parameters:
    
    command - The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - args
```
EksContainerDetail.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
```
EksContainerDetail.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
```
EksContainerDetail.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
```
EksContainerDetail.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
```
EksContainerDetail.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
```
EksContainerDetail.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 EksContainerDetail.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)
  - exitCode
```
EksContainerDetail.Builder exitCode(Integer exitCode)
```
    The exit code for the job attempt. A non-zero exit code is considered failed.
    
    Parameters:
    
    exitCode - The exit code for the job attempt. A non-zero exit code is considered failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - reason
```
EksContainerDetail.Builder reason(String reason)
```
    A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.
    
    Parameters:
    
    reason - A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - volumeMounts
```
EksContainerDetail.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
```
EksContainerDetail.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
```
EksContainerDetail.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
```
EksContainerDetail.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 EksContainerDetail.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)

Interface EksContainerDetail.Builder

Method Summary

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

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

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

Method Detail

name

image

imagePullPolicy

command

command

args

args

env

env

env

resources

resources

exitCode

reason

volumeMounts

volumeMounts

volumeMounts

securityContext

securityContext