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

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::EksContainer

Defined in:

gems/aws-sdk-batch/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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #args ⇒ Array<String>

  An array of arguments to the entrypoint.

• #command ⇒ Array<String>

  The entrypoint for the container.

• #env ⇒ Array<Types::EksContainerEnvironmentVariable>

  The environment variables to pass to a container.

• #image ⇒ String

  The Docker image used to start the container.

• #image_pull_policy ⇒ String

  The image pull policy for the container.

• #name ⇒ String

  The name of the container.

• #resources ⇒ Types::EksContainerResourceRequirements

  The type and amount of resources to assign to a container.

• #security_context ⇒ Types::EksContainerSecurityContext

  The security context for a job.

• #volume_mounts ⇒ Array<Types::EksContainerVolumeMount>

  The volume mounts for the container.

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 and Define a command and arguments for a pod in the Kubernetes documentation.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-batch/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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-batch/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.

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

Returns:

• (Array<Types::EksContainerEnvironmentVariable>)

# File 'gems/aws-sdk-batch/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)

# File 'gems/aws-sdk-batch/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.

Returns:

• (String)

# File 'gems/aws-sdk-batch/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)

# File 'gems/aws-sdk-batch/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.

Returns:

• (Types::EksContainerResourceRequirements)

# File 'gems/aws-sdk-batch/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.

Returns:

• (Types::EksContainerSecurityContext)

# File 'gems/aws-sdk-batch/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.

Returns:

• (Array<Types::EksContainerVolumeMount>)

# File 'gems/aws-sdk-batch/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