Skip to content

EngineConfiguration

Source code in docs_src/capo_athena/types/engine_configuration.py
class EngineConfiguration(TypedDict, closed=True):
    coordinator_dpu_size: NotRequired[
        "capo_athena.types.coordinator_dpu_size.CoordinatorDpuSize"
    ]
    """<p>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. The default is 1.</p>"""
    max_concurrent_dpus: "capo_athena.types.max_concurrent_dpus.MaxConcurrentDpus"
    """<p>The maximum number of DPUs that can run concurrently.</p>"""
    default_executor_dpu_size: NotRequired[
        "capo_athena.types.default_executor_dpu_size.DefaultExecutorDpuSize"
    ]
    """<p>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. The default is 1.</p>"""
    additional_configs: NotRequired["capo_athena.types.parameters_map.ParametersMap"]
    """<p>Contains additional notebook engine <code>MAP<string, string></code> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the <a>StartSessionRequest$NotebookVersion</a> field, and then add a key named <code>NotebookId</code> to <code>AdditionalConfigs</code> that has the value of the Athena notebook ID.</p>"""
    spark_properties: NotRequired["capo_athena.types.parameters_map.ParametersMap"]
    """<p>Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.</p>"""
    classifications: NotRequired[
        "capo_athena.types.classification_list.ClassificationList"
    ]
    """<p>The configuration classifications that can be specified for the engine.</p>"""

additional_configs instance-attribute

additional_configs: NotRequired[ParametersMap]

Contains additional notebook engine MAP parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.

classifications instance-attribute

classifications: NotRequired[ClassificationList]

The configuration classifications that can be specified for the engine.

coordinator_dpu_size instance-attribute

coordinator_dpu_size: NotRequired[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. The default is 1.

default_executor_dpu_size instance-attribute

default_executor_dpu_size: NotRequired[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. The default is 1.

max_concurrent_dpus instance-attribute

max_concurrent_dpus: MaxConcurrentDpus

The maximum number of DPUs that can run concurrently.

spark_properties instance-attribute

spark_properties: NotRequired[ParametersMap]

Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.