amazonka-pipes-2.0: Amazon EventBridge Pipes SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Pipes.Types.BatchContainerOverrides

Description

 
Synopsis

Documentation

data BatchContainerOverrides Source #

The overrides that are sent to a container.

See: newBatchContainerOverrides smart constructor.

Constructors

BatchContainerOverrides' 

Fields

  • command :: Maybe [Text]

    The command to send to the container that overrides the default command from the Docker image or the task definition.

  • environment :: Maybe [BatchEnvironmentVariable]

    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 task definition.

    Environment variables cannot start with "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.

  • resourceRequirements :: Maybe [BatchResourceRequirement]

    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.

Instances

Instances details
FromJSON BatchContainerOverrides Source # 
Instance details

Defined in Amazonka.Pipes.Types.BatchContainerOverrides

ToJSON BatchContainerOverrides Source # 
Instance details

Defined in Amazonka.Pipes.Types.BatchContainerOverrides

Generic BatchContainerOverrides Source # 
Instance details

Defined in Amazonka.Pipes.Types.BatchContainerOverrides

Associated Types

type Rep BatchContainerOverrides :: Type -> Type #

Read BatchContainerOverrides Source # 
Instance details

Defined in Amazonka.Pipes.Types.BatchContainerOverrides

Show BatchContainerOverrides Source # 
Instance details

Defined in Amazonka.Pipes.Types.BatchContainerOverrides

NFData BatchContainerOverrides Source # 
Instance details

Defined in Amazonka.Pipes.Types.BatchContainerOverrides

Methods

rnf :: BatchContainerOverrides -> () #

Eq BatchContainerOverrides Source # 
Instance details

Defined in Amazonka.Pipes.Types.BatchContainerOverrides

Hashable BatchContainerOverrides Source # 
Instance details

Defined in Amazonka.Pipes.Types.BatchContainerOverrides

type Rep BatchContainerOverrides Source # 
Instance details

Defined in Amazonka.Pipes.Types.BatchContainerOverrides

type Rep BatchContainerOverrides = D1 ('MetaData "BatchContainerOverrides" "Amazonka.Pipes.Types.BatchContainerOverrides" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "BatchContainerOverrides'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchEnvironmentVariable]))) :*: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchResourceRequirement])))))

newBatchContainerOverrides :: BatchContainerOverrides Source #

Create a value of BatchContainerOverrides 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:BatchContainerOverrides', batchContainerOverrides_command - The command to send to the container that overrides the default command from the Docker image or the task definition.

$sel:environment:BatchContainerOverrides', batchContainerOverrides_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 task definition.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

$sel:instanceType:BatchContainerOverrides', batchContainerOverrides_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:resourceRequirements:BatchContainerOverrides', batchContainerOverrides_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.

batchContainerOverrides_command :: Lens' BatchContainerOverrides (Maybe [Text]) Source #

The command to send to the container that overrides the default command from the Docker image or the task definition.

batchContainerOverrides_environment :: Lens' BatchContainerOverrides (Maybe [BatchEnvironmentVariable]) 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 task definition.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

batchContainerOverrides_instanceType :: Lens' BatchContainerOverrides (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.

batchContainerOverrides_resourceRequirements :: Lens' BatchContainerOverrides (Maybe [BatchResourceRequirement]) 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.