AWS::Athena::WorkGroup EngineConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Athena::WorkGroup EngineConfiguration

The engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when running in provisioned capacity. If not specified, Athena uses default values (Default value for min is 4 and for max is Minimum of 124 and allocated DPUs).

To specify DPU values for PC queries the WG containing EngineConfiguration should have the following values: The name of the Classifications should be athena-query-engine-properties, with the only allowed properties as max-dpu-count and min-dpu-count.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AdditionalConfigs" : {Key: Value, ...},
  "Classifications" : [ Classification, ... ],
  "CoordinatorDpuSize" : Integer,
  "DefaultExecutorDpuSize" : Integer,
  "MaxConcurrentDpus" : Integer,
  "SparkProperties" : {Key: Value, ...}
}

Properties

AdditionalConfigs

Contains additional notebook engine MAP<string, string> 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.

Required: No

Type: Object of String

Pattern: ^.+$

Update requires: No interruption

Classifications

The configuration classifications that can be specified for the engine.

Required: No

Type: Array of Classification

Update requires: No interruption

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.

Required: No

Type: Integer

Minimum: 1

Maximum: 1

Update requires: No interruption

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.

Required: No

Type: Integer

Minimum: 1

Maximum: 1

Update requires: No interruption

MaxConcurrentDpus

The maximum number of DPUs that can run concurrently.

Required: No

Type: Integer

Minimum: 2

Maximum: 5000

Update requires: No interruption

SparkProperties

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

Required: No

Type: Object of String

Pattern: ^.+$

Update requires: No interruption