Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
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.
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 indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.
This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.
vcpus :: Maybe Int
This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.
This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

Instances

Instances details

Eq ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Methods (==) :: ContainerOverrides -> ContainerOverrides -> Bool # (/=) :: ContainerOverrides -> ContainerOverrides -> Bool #
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 #
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 #
NFData ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Methods rnf :: ContainerOverrides -> () #
Hashable ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Methods hashWithSalt :: Int -> ContainerOverrides -> Int # hash :: ContainerOverrides -> Int #
ToJSON ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides Methods toJSON :: ContainerOverrides -> Value # toEncoding :: ContainerOverrides -> Encoding # toJSONList :: [ContainerOverrides] -> Value # toEncodingList :: [ContainerOverrides] -> Encoding #
type Rep ContainerOverrides Source #
Instance details Defined in Amazonka.Batch.Types.ContainerOverrides type Rep ContainerOverrides = D1 ('MetaData "ContainerOverrides" "Amazonka.Batch.Types.ContainerOverrides" "libZSservicesZSamazonka-batchZSamazonka-batch" '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 "resourceRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceRequirement])))) :: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "memory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: 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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

$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: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 indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

$sel:vcpus:ContainerOverrides', containerOverrides_vcpus - This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

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_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 indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

containerOverrides_vcpus :: Lens' ContainerOverrides (Maybe Int) Source #

This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.