interface EngineConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.Athena.Mixins.CfnWorkGroupPropsMixin.EngineConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsathena/mixins#CfnWorkGroupPropsMixin_EngineConfigurationProperty |
 Java | software.amazon.awscdk.mixins.preview.services.athena.mixins.CfnWorkGroupPropsMixin.EngineConfigurationProperty |
 Python | aws_cdk.mixins_preview.aws_athena.mixins.CfnWorkGroupPropsMixin.EngineConfigurationProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_athena » mixins » CfnWorkGroupPropsMixin » EngineConfigurationProperty |
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 .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as athena_mixins } from '@aws-cdk/mixins-preview/aws-athena';
const engineConfigurationProperty: athena_mixins.CfnWorkGroupPropsMixin.EngineConfigurationProperty = {
additionalConfigs: {
additionalConfigsKey: 'additionalConfigs',
},
classifications: [{
name: 'name',
properties: {
propertiesKey: 'properties',
},
}],
coordinatorDpuSize: 123,
defaultExecutorDpuSize: 123,
maxConcurrentDpus: 123,
sparkProperties: {
sparkPropertiesKey: 'sparkProperties',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| additional | { [string]: string } | IResolvable | Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. |
| classifications? | IResolvable | (IResolvable | Classification)[] | The configuration classifications that can be specified for the engine. |
| coordinator | number | The number of DPUs to use for the coordinator. |
| default | number | The default number of DPUs to use for executors. |
| max | number | The maximum number of DPUs that can run concurrently. |
| spark | { [string]: string } | IResolvable | Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning. |
additionalConfigs?
Type:
{ [string]: string } | IResolvable
(optional)
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.
classifications?
Type:
IResolvable | (IResolvable | Classification)[]
(optional)
The configuration classifications that can be specified for the engine.
coordinatorDpuSize?
Type:
number
(optional)
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.
defaultExecutorDpuSize?
Type:
number
(optional)
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.
maxConcurrentDpus?
Type:
number
(optional)
The maximum number of DPUs that can run concurrently.
sparkProperties?
Type:
{ [string]: string } | IResolvable
(optional)
Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.