You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Batch::Types::ContainerOverrides

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::ContainerOverrides

Defined in:

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

Overview

Note:

When making an API call, you may pass ContainerOverrides data as a hash:

{
  vcpus: 1,
  memory: 1,
  command: ["String"],
  instance_type: "String",
  environment: [
    {
      name: "String",
      value: "String",
    },
  ],
  resource_requirements: [
    {
      value: "String", # required
      type: "GPU", # required, accepts GPU
    },
  ],
}

The overrides that should be sent to a container.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #command ⇒ Array<String>

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

• #environment ⇒ Array<Types::KeyValuePair>

  The environment variables to send to the container.

• #instance_type ⇒ String

  The instance type to use for a multi-node parallel job.

• #memory ⇒ Integer

  The number of MiB of memory reserved for the job.

• #resource_requirements ⇒ Array<Types::ResourceRequirement>

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

• #vcpus ⇒ Integer

  The number of vCPUs to reserve for the container.

Instance Attribute Details

#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 708

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  include Aws::Structure
end

#environment ⇒ Array<Types::KeyValuePair>

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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Returns:

• (Array<Types::KeyValuePair>)

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

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  include Aws::Structure
end

#instance_type ⇒ String

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

Returns:

• (String)

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

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  include Aws::Structure
end

#memory ⇒ Integer

The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.

Returns:

• (Integer)

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

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  include Aws::Structure
end

#resource_requirements ⇒ Array<Types::ResourceRequirement>

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

Returns:

• (Array<Types::ResourceRequirement>)

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

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  include Aws::Structure
end

#vcpus ⇒ Integer

The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.

Returns:

• (Integer)

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

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  include Aws::Structure
end