Show / Hide Table of Contents

Interface CfnWorkGroupPropsMixin.IEngineConfigurationProperty

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.

Namespace: Amazon.CDK.Mixins.Preview.AWS.Athena.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public interface CfnWorkGroupPropsMixin.IEngineConfigurationProperty
Syntax (vb)
Public Interface CfnWorkGroupPropsMixin.IEngineConfigurationProperty
Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Athena.Mixins;

             var engineConfigurationProperty = new EngineConfigurationProperty {
                 AdditionalConfigs = new Dictionary<string, string> {
                     { "additionalConfigsKey", "additionalConfigs" }
                 },
                 Classifications = new [] { new ClassificationProperty {
                     Name = "name",
                     Properties = new Dictionary<string, string> {
                         { "propertiesKey", "properties" }
                     }
                 } },
                 CoordinatorDpuSize = 123,
                 DefaultExecutorDpuSize = 123,
                 MaxConcurrentDpus = 123,
                 SparkProperties = new Dictionary<string, string> {
                     { "sparkPropertiesKey", "sparkProperties" }
                 }
             };

Synopsis

Properties

AdditionalConfigs

Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs.

Classifications

The configuration classifications that can be specified for the engine.

CoordinatorDpuSize

The number of DPUs to use for the coordinator.

DefaultExecutorDpuSize

The default number of DPUs to use for executors.

MaxConcurrentDpus

The maximum number of DPUs that can run concurrently.

SparkProperties

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

Properties

AdditionalConfigs

Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs.

object? AdditionalConfigs { get; }
Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-additionalconfigs

Type union: either Dictionary<string, string> or IResolvable

Classifications

The configuration classifications that can be specified for the engine.

object? Classifications { get; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-classifications

Type union: either IResolvable or (either IResolvable or CfnWorkGroupPropsMixin.IClassificationProperty)[]

CoordinatorDpuSize

The number of DPUs to use for the coordinator.

double? CoordinatorDpuSize { get; }
Property Value

double?

Remarks

A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-coordinatordpusize

DefaultExecutorDpuSize

The default number of DPUs to use for executors.

double? DefaultExecutorDpuSize { get; }
Property Value

double?

Remarks

An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-defaultexecutordpusize

MaxConcurrentDpus

The maximum number of DPUs that can run concurrently.

double? MaxConcurrentDpus { get; }
Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-maxconcurrentdpus

SparkProperties

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

object? SparkProperties { get; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-sparkproperties

Type union: either Dictionary<string, string> or IResolvable

Back to top Generated by DocFX