Amazonka.Athena.Types.EngineConfiguration

Documentation

data EngineConfiguration

Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine.

See: newEngineConfiguration smart constructor.

Constructors

EngineConfiguration'

Fields

• additionalConfigs :: Maybe (HashMap Text Text)

  Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Amazon S3 URI that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookFileURI to AdditionalConfigs that has value of the Amazon S3 URI.

• coordinatorDpuSize :: Maybe Natural

  The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.

• defaultExecutorDpuSize :: Maybe Natural

  The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.

• maxConcurrentDpus :: Natural

  The maximum number of DPUs that can run concurrently.

Instances

FromJSON EngineConfiguration

Defined in Amazonka.Athena.Types.EngineConfiguration

Methods

parseJSON :: Value -> Parser EngineConfiguration

parseJSONList :: Value -> Parser [EngineConfiguration]

ToJSON EngineConfiguration

Defined in Amazonka.Athena.Types.EngineConfiguration

Methods

toJSON :: EngineConfiguration -> Value

toEncoding :: EngineConfiguration -> Encoding

toJSONList :: [EngineConfiguration] -> Value

toEncodingList :: [EngineConfiguration] -> Encoding

Generic EngineConfiguration

Defined in Amazonka.Athena.Types.EngineConfiguration

Associated Types

type Rep EngineConfiguration :: Type -> Type

Methods

from :: EngineConfiguration -> Rep EngineConfiguration x

to :: Rep EngineConfiguration x -> EngineConfiguration

Read EngineConfiguration

Defined in Amazonka.Athena.Types.EngineConfiguration

Methods

readsPrec :: Int -> ReadS EngineConfiguration

readList :: ReadS [EngineConfiguration]

readPrec :: ReadPrec EngineConfiguration

readListPrec :: ReadPrec [EngineConfiguration]

Show EngineConfiguration

Defined in Amazonka.Athena.Types.EngineConfiguration

Methods

showsPrec :: Int -> EngineConfiguration -> ShowS

show :: EngineConfiguration -> String

showList :: [EngineConfiguration] -> ShowS

NFData EngineConfiguration

Defined in Amazonka.Athena.Types.EngineConfiguration

Methods

rnf :: EngineConfiguration -> ()

Eq EngineConfiguration

Defined in Amazonka.Athena.Types.EngineConfiguration

Methods

(==) :: EngineConfiguration -> EngineConfiguration -> Bool

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

Hashable EngineConfiguration

Defined in Amazonka.Athena.Types.EngineConfiguration

Methods

hashWithSalt :: Int -> EngineConfiguration -> Int

hash :: EngineConfiguration -> Int

type Rep EngineConfiguration

Defined in Amazonka.Athena.Types.EngineConfiguration

type Rep EngineConfiguration = D1 ('MetaData "EngineConfiguration" "Amazonka.Athena.Types.EngineConfiguration" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "EngineConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "additionalConfigs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "coordinatorDpuSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "defaultExecutorDpuSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "maxConcurrentDpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newEngineConfiguration

Arguments

:: Natural

$sel:maxConcurrentDpus:EngineConfiguration'

-> EngineConfiguration

Create a value of EngineConfiguration 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:additionalConfigs:EngineConfiguration', engineConfiguration_additionalConfigs - Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Amazon S3 URI that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookFileURI to AdditionalConfigs that has value of the Amazon S3 URI.

$sel:coordinatorDpuSize:EngineConfiguration', engineConfiguration_coordinatorDpuSize - The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.

$sel:defaultExecutorDpuSize:EngineConfiguration', engineConfiguration_defaultExecutorDpuSize - The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.

$sel:maxConcurrentDpus:EngineConfiguration', engineConfiguration_maxConcurrentDpus - The maximum number of DPUs that can run concurrently.

engineConfiguration_additionalConfigs :: Lens' EngineConfiguration (Maybe (HashMap Text Text))

Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Amazon S3 URI that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookFileURI to AdditionalConfigs that has value of the Amazon S3 URI.

engineConfiguration_coordinatorDpuSize :: Lens' EngineConfiguration (Maybe Natural)

The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session.

engineConfiguration_defaultExecutorDpuSize :: Lens' EngineConfiguration (Maybe Natural)

The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena.

engineConfiguration_maxConcurrentDpus :: Lens' EngineConfiguration Natural

The maximum number of DPUs that can run concurrently.