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
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, VCPU, MEMORY
},
],
}
The overrides that should be sent to a container.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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 thevcpus
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.
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1615 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.
AWS_BATCH
; this naming
convention is reserved for variables that are set by the Batch
service.
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1615 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.
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1615 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 running on
EC2 resources, it overrides the memory
parameter set in the job
definition, but doesn't override any memory requirement 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.
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1615 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
.
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1615 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 running on
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.
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1615 class ContainerOverrides < Struct.new( :vcpus, :memory, :command, :instance_type, :environment, :resource_requirements) SENSITIVE = [] include Aws::Structure end |