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

Inherits:
Struct
  • Object
show all
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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# 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

#environmentArray<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:



1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# 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_typeString

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)


1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# 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

#memoryInteger

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)


1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# 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_requirementsArray<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:



1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# 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

#vcpusInteger

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)


1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# 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