Class: Aws::Batch::Types::EksContainerOverride

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::EksContainerOverride

Defined in:

gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #args ⇒ Array<String>

  The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition.

• #command ⇒ Array<String>

  The command to send to the container that overrides the default command from the Docker image or the job definition.

• #env ⇒ Array<Types::EksContainerEnvironmentVariable>

  The environment variables to send to the container.

• #image ⇒ String

  The override of the Docker image that's used to start the container.

• #name ⇒ String

  A pointer to the container that you want to override.

• #resources ⇒ Types::EksContainerResourceRequirements

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

Instance Attribute Details

#args ⇒ Array<String>

The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see Dockerfile reference: CMD and Define a command an arguments for a pod in the Kubernetes documentation.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3748

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

#command ⇒ Array<String>

The command to send to the container that overrides the default command from the Docker image or the job definition.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3748

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

#env ⇒ Array<Types::EksContainerEnvironmentVariable>

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch. Or, you can override the existing environment variables from the Docker image or the job definition.

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 3748

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

#image ⇒ String

The override of the Docker image that's used to start the container.

Returns:

• (String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3748

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

#name ⇒ String

A pointer to the container that you want to override. The name must match a unique container name that you wish to override.

Returns:

• (String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3748

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

#resources ⇒ Types::EksContainerResourceRequirements

The type and amount of resources to assign to a container. These override the settings in the job definition. 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 3748

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