amazonka-batch-2.0: Amazon Batch 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.Batch.Types.NodeOverrides

Description

 
Synopsis

Documentation

data NodeOverrides Source #

An object that represents any node overrides to a job definition that's used in a SubmitJob API operation.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs. Rather, use containerOverrides instead.

See: newNodeOverrides smart constructor.

Constructors

NodeOverrides' 

Fields

  • nodePropertyOverrides :: Maybe [NodePropertyOverride]

    The node property overrides for the job.

  • numNodes :: Maybe Int

    The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions:

    • There must be at least one node range in your job definition that has an open upper boundary, such as : or n:.
    • The lower boundary of the node range that's specified in the job definition must be fewer than the number of nodes specified in the override.
    • The main node index that's specified in the job definition must be fewer than the number of nodes specified in the override.

Instances

Instances details
ToJSON NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

Generic NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

Associated Types

type Rep NodeOverrides :: Type -> Type #

Read NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

Show NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

NFData NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

Methods

rnf :: NodeOverrides -> () #

Eq NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

Hashable NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

type Rep NodeOverrides Source # 
Instance details

Defined in Amazonka.Batch.Types.NodeOverrides

type Rep NodeOverrides = D1 ('MetaData "NodeOverrides" "Amazonka.Batch.Types.NodeOverrides" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "NodeOverrides'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nodePropertyOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NodePropertyOverride])) :*: S1 ('MetaSel ('Just "numNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newNodeOverrides :: NodeOverrides Source #

Create a value of NodeOverrides 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:nodePropertyOverrides:NodeOverrides', nodeOverrides_nodePropertyOverrides - The node property overrides for the job.

$sel:numNodes:NodeOverrides', nodeOverrides_numNodes - The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions:

  • There must be at least one node range in your job definition that has an open upper boundary, such as : or n:.
  • The lower boundary of the node range that's specified in the job definition must be fewer than the number of nodes specified in the override.
  • The main node index that's specified in the job definition must be fewer than the number of nodes specified in the override.

nodeOverrides_numNodes :: Lens' NodeOverrides (Maybe Int) Source #

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions:

  • There must be at least one node range in your job definition that has an open upper boundary, such as : or n:.
  • The lower boundary of the node range that's specified in the job definition must be fewer than the number of nodes specified in the override.
  • The main node index that's specified in the job definition must be fewer than the number of nodes specified in the override.