Amazonka.Batch.Types.EksContainerOverride

Documentation

data EksContainerOverride

Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.

See: newEksContainerOverride smart constructor.

Constructors

EksContainerOverride'

Fields

• args :: Maybe [Text]

  The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see CMD in the Dockerfile reference and Define a command an arguments for a pod in the Kubernetes documentation.

• command :: Maybe [Text]

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

• env :: Maybe [EksContainerEnvironmentVariable]

  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.

• image :: Maybe Text

  The override of the Docker image that's used to start the container.

• resources :: Maybe EksContainerResourceRequirements

  The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

Instances

ToJSON EksContainerOverride

Defined in Amazonka.Batch.Types.EksContainerOverride

Methods

toJSON :: EksContainerOverride -> Value

toEncoding :: EksContainerOverride -> Encoding

toJSONList :: [EksContainerOverride] -> Value

toEncodingList :: [EksContainerOverride] -> Encoding

Generic EksContainerOverride

Defined in Amazonka.Batch.Types.EksContainerOverride

Associated Types

type Rep EksContainerOverride :: Type -> Type

Methods

from :: EksContainerOverride -> Rep EksContainerOverride x

to :: Rep EksContainerOverride x -> EksContainerOverride

Read EksContainerOverride

Defined in Amazonka.Batch.Types.EksContainerOverride

Methods

readsPrec :: Int -> ReadS EksContainerOverride

readList :: ReadS [EksContainerOverride]

readPrec :: ReadPrec EksContainerOverride

readListPrec :: ReadPrec [EksContainerOverride]

Show EksContainerOverride

Defined in Amazonka.Batch.Types.EksContainerOverride

Methods

showsPrec :: Int -> EksContainerOverride -> ShowS

show :: EksContainerOverride -> String

showList :: [EksContainerOverride] -> ShowS

NFData EksContainerOverride

Defined in Amazonka.Batch.Types.EksContainerOverride

Methods

rnf :: EksContainerOverride -> ()

Eq EksContainerOverride

Defined in Amazonka.Batch.Types.EksContainerOverride

Methods

(==) :: EksContainerOverride -> EksContainerOverride -> Bool

(/=) :: EksContainerOverride -> EksContainerOverride -> Bool

Hashable EksContainerOverride

Defined in Amazonka.Batch.Types.EksContainerOverride

Methods

hashWithSalt :: Int -> EksContainerOverride -> Int

hash :: EksContainerOverride -> Int

type Rep EksContainerOverride

Defined in Amazonka.Batch.Types.EksContainerOverride

type Rep EksContainerOverride = D1 ('MetaData "EksContainerOverride" "Amazonka.Batch.Types.EksContainerOverride" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksContainerOverride'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "args") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "env") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksContainerEnvironmentVariable])) :*: (S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksContainerResourceRequirements))))))

newEksContainerOverride :: EksContainerOverride

Create a value of EksContainerOverride 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:args:EksContainerOverride', eksContainerOverride_args - The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see CMD in the Dockerfile reference and Define a command an arguments for a pod in the Kubernetes documentation.

$sel:command:EksContainerOverride', eksContainerOverride_command - The command to send to the container that overrides the default command from the Docker image or the job definition.

$sel:env:EksContainerOverride', eksContainerOverride_env - 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:image:EksContainerOverride', eksContainerOverride_image - The override of the Docker image that's used to start the container.

$sel:resources:EksContainerOverride', eksContainerOverride_resources - The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

eksContainerOverride_args :: Lens' EksContainerOverride (Maybe [Text])

The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see CMD in the Dockerfile reference and Define a command an arguments for a pod in the Kubernetes documentation.

eksContainerOverride_command :: Lens' EksContainerOverride (Maybe [Text])

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

eksContainerOverride_env :: Lens' EksContainerOverride (Maybe [EksContainerEnvironmentVariable])

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.

eksContainerOverride_image :: Lens' EksContainerOverride (Maybe Text)

The override of the Docker image that's used to start the container.

eksContainerOverride_resources :: Lens' EksContainerOverride (Maybe EksContainerResourceRequirements)

The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.