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

Amazonka.Batch.Types.ContainerOverrides

Description

Documentation

data ContainerOverrides Source #

The overrides that should be sent to a container.

See: newContainerOverrides smart constructor.

Constructors

ContainerOverrides'

Fields

command :: Maybe [Text]
The command to send to the container that overrides the default command from the Docker image or the job definition.
environment :: Maybe [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 cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.
instanceType :: Maybe Text
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.
memory :: Maybe Int
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.
resourceRequirements :: Maybe [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.
vcpus :: Maybe Int
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.

Instances

Instances details

ToJSON ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Methods toJSON :: ContainerOverrides -> Value # toEncoding :: ContainerOverrides -> Encoding # toJSONList :: [ContainerOverrides] -> Value # toEncodingList :: [ContainerOverrides] -> Encoding #
Generic ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Associated Types type Rep ContainerOverrides :: Type -> Type # Methods from :: ContainerOverrides -> Rep ContainerOverrides x # to :: Rep ContainerOverrides x -> ContainerOverrides #
Read ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Methods readsPrec :: Int -> ReadS ContainerOverrides # readList :: ReadS [ContainerOverrides] # readPrec :: ReadPrec ContainerOverrides # readListPrec :: ReadPrec [ContainerOverrides] #
Show ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Methods showsPrec :: Int -> ContainerOverrides -> ShowS # show :: ContainerOverrides -> String # showList :: [ContainerOverrides] -> ShowS #
NFData ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Methods rnf :: ContainerOverrides -> () #
Eq ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Methods (==) :: ContainerOverrides -> ContainerOverrides -> Bool # (/=) :: ContainerOverrides -> ContainerOverrides -> Bool #
Hashable ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Methods hashWithSalt :: Int -> ContainerOverrides -> Int # hash :: ContainerOverrides -> Int #
type Rep ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides type Rep ContainerOverrides = D1 ('MetaData "ContainerOverrides" "Amazonka.Batch.Types.ContainerOverrides" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ContainerOverrides'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyValuePair])) :: S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "resourceRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceRequirement])) :*: S1 ('MetaSel ('Just "vcpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

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.