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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-batch/types.rb

Overview

The overrides that should be sent to a container.

For information about using Batch overrides when you connect event sources to targets, see [BatchContainerOverrides].

[1]: docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_BatchContainerOverrides.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

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

  This parameter is deprecated, use ‘resourceRequirements` to override the memory requirements specified in the job definition.

• #resource_requirements ⇒ Array<Types::ResourceRequirement>

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

• #vcpus ⇒ Integer

  This parameter is deprecated, use ‘resourceRequirements` to override the `vcpus` parameter that’s set in the job definition.

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.

<note markdown=“1”> This parameter can’t contain an empty string.

</note>

Returns:

• (Array<String>)

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

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  SENSITIVE = []
  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.

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

</note>

Returns:

• (Array<Types::KeyValuePair>)

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

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

#instance_type ⇒ String

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

<note markdown=“1”> This parameter isn’t applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn’t be provided.

</note>

Returns:

• (String)

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

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

#memory ⇒ Integer

This parameter is deprecated, use ‘resourceRequirements` to override the memory requirements specified in the job definition. It’s not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the ‘memory` parameter set in the job definition, but doesn’t override any memory requirement that’s specified in the ‘resourceRequirements` structure in the job definition. To override memory requirements that are specified in the `resourceRequirements` structure in the job definition, `resourceRequirements` must be specified in the `SubmitJob` request, with `type` set to `MEMORY` and `value` set to the new value. For more information, see [Can’t override job definition resource requirements] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements

Returns:

• (Integer)

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

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

#resource_requirements ⇒ Array<Types::ResourceRequirement>

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include ‘GPU`, `MEMORY`, and `VCPU`.

Returns:

• (Array<Types::ResourceRequirement>)

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

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

#vcpus ⇒ Integer

This parameter is deprecated, use ‘resourceRequirements` to override the `vcpus` parameter that’s set in the job definition. It’s not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the ‘vcpus` parameter set in the job definition, but doesn’t override any vCPU requirement specified in the ‘resourceRequirements` structure in the job definition. To override vCPU requirements that are specified in the `resourceRequirements` structure in the job definition, `resourceRequirements` must be specified in the `SubmitJob` request, with `type` set to `VCPU` and `value` set to the new value. For more information, see [Can’t override job definition resource requirements] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements

Returns:

• (Integer)

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

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