Class: Aws::Batch::Types::EksContainer

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

Overview

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:

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>) 


3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/aws-sdk-batch/types.rb', line 3511

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

#command ⇒ Array<String>

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

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

Returns:

  • (Array<String>) 


3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/aws-sdk-batch/types.rb', line 3511

class EksContainer < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :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:



3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/aws-sdk-batch/types.rb', line 3511

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

#image ⇒ String

The Docker image used to start the container.

Returns:

  • (String) 


3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/aws-sdk-batch/types.rb', line 3511

class EksContainer < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :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 `IfNotPresent`. However, if the `:latest` tag is specified, it defaults to `Always`. For more information, see [Updating images] in the *Kubernetes documentation*.

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

Returns:

  • (String) 


3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/aws-sdk-batch/types.rb', line 3511

class EksContainer < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :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) 


3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/aws-sdk-batch/types.rb', line 3511

class EksContainer < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :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:



3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/aws-sdk-batch/types.rb', line 3511

class EksContainer < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :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:



3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/aws-sdk-batch/types.rb', line 3511

class EksContainer < Struct.new(
  :name,
  :image,
  :image_pull_policy,
  :command,
  :args,
  :env,
  :resources,
  :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:



3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
 
# File 'lib/aws-sdk-batch/types.rb', line 3511

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