Class: Aws::Batch::Types::EksContainerDetail

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-batch/types.rb

Overview

The details for container properties that are returned by ‘DescribeJobs` for jobs that use Amazon EKS.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#args ⇒ Array<String>

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

Dockerfile reference: CMD][3

and [Define a command and arguments

for a pod] in the *Kubernetes documentation*.

[1]: kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint [2]: kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/ [3]: docs.docker.com/engine/reference/builder/#cmd [4]: kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/

Returns:

  • (Array<String>) 


3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end

#command ⇒ Array<String>

The entrypoint for the container. For more information, see

Entrypoint][1

in the *Kubernetes documentation*.

[1]: kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint

Returns:

  • (Array<String>) 


3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end

#env ⇒ Array<Types::EksContainerEnvironmentVariable>

The environment variables to pass to a container.

<note markdown=“1”> Environment variables cannot start with “‘AWS_BATCH`”. This naming convention is reserved for variables that Batch sets.

</note>

Returns:



3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end

#exit_code ⇒ Integer

The exit code returned for the job attempt. A non-zero exit code is considered failed.

Returns:

  • (Integer) 


3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end

#image ⇒ String

The Docker image used to start the container.

Returns:

  • (String) 


3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end

#image_pull_policy ⇒ String

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*.

[1]: kubernetes.io/docs/concepts/containers/images/#updating-images

Returns:

  • (String) 


3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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:

  • (String) 


3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end

#reason ⇒ String

A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

Returns:

  • (String) 


3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end

#resources ⇒ Types::EksContainerResourceRequirements

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*.

[1]: kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Returns:



3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end

#security_context ⇒ Types::EksContainerSecurityContext

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

[1]: kubernetes.io/docs/tasks/configure-pod-container/security-context/

Returns:



3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end

#volume_mounts ⇒ Array<Types::EksContainerVolumeMount>

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*.

[1]: kubernetes.io/docs/concepts/storage/volumes/

Returns:



3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
 
# File 'lib/aws-sdk-batch/types.rb', line 3652

class EksContainerDetail < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :exit_code,
  :reason,
  :volume_mounts,
  :security_context)
  SENSITIVE = []
  include Aws::Structure
end