Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ContainerOverrides = ContainerOverrides' {
- command :: Maybe [Text]
- environment :: Maybe [KeyValuePair]
- instanceType :: Maybe Text
- memory :: Maybe Int
- resourceRequirements :: Maybe [ResourceRequirement]
- vcpus :: Maybe Int
- newContainerOverrides :: ContainerOverrides
- containerOverrides_command :: Lens' ContainerOverrides (Maybe [Text])
- containerOverrides_environment :: Lens' ContainerOverrides (Maybe [KeyValuePair])
- containerOverrides_instanceType :: Lens' ContainerOverrides (Maybe Text)
- containerOverrides_memory :: Lens' ContainerOverrides (Maybe Int)
- containerOverrides_resourceRequirements :: Lens' ContainerOverrides (Maybe [ResourceRequirement])
- containerOverrides_vcpus :: Lens' ContainerOverrides (Maybe Int)
Documentation
data ContainerOverrides Source #
The overrides that should be sent to a container.
See: newContainerOverrides
smart constructor.
ContainerOverrides' | |
|
Instances
newContainerOverrides :: ContainerOverrides Source #
Create a value of ContainerOverrides
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:command:ContainerOverrides'
, containerOverrides_command
- The command to send to the container that overrides the default command
from the Docker image or the job definition.
$sel:environment:ContainerOverrides'
, containerOverrides_environment
- 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.
$sel:instanceType:ContainerOverrides'
, containerOverrides_instanceType
- The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
$sel:memory:ContainerOverrides'
, containerOverrides_memory
- 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 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.
$sel:resourceRequirements:ContainerOverrides'
, containerOverrides_resourceRequirements
- 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
.
$sel:vcpus:ContainerOverrides'
, containerOverrides_vcpus
- 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 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.
containerOverrides_command :: Lens' ContainerOverrides (Maybe [Text]) Source #
The command to send to the container that overrides the default command from the Docker image or the job definition.
containerOverrides_environment :: Lens' ContainerOverrides (Maybe [KeyValuePair]) Source #
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.
containerOverrides_instanceType :: Lens' ContainerOverrides (Maybe Text) Source #
The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
containerOverrides_memory :: Lens' ContainerOverrides (Maybe Int) Source #
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 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.
containerOverrides_resourceRequirements :: Lens' ContainerOverrides (Maybe [ResourceRequirement]) Source #
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
.
containerOverrides_vcpus :: Lens' ContainerOverrides (Maybe Int) Source #
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 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.