Package software.amazon.awscdk.services.athena

Interface CfnWorkGroup.EngineConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkGroup.EngineConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnWorkGroup

@Stability(Stable)
public static interface CfnWorkGroup.EngineConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.athena.*;
 EngineConfigurationProperty engineConfigurationProperty = EngineConfigurationProperty.builder()
         .additionalConfigs(Map.of(
                 "additionalConfigsKey", "additionalConfigs"))
         .classifications(List.of(ClassificationProperty.builder()
                 .name("name")
                 .properties(Map.of(
                         "propertiesKey", "properties"))
                 .build()))
         .coordinatorDpuSize(123)
         .defaultExecutorDpuSize(123)
         .maxConcurrentDpus(123)
         .sparkProperties(Map.of(
                 "sparkPropertiesKey", "sparkProperties"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkGroup.EngineConfigurationProperty.Builder	A builder for CfnWorkGroup.EngineConfigurationProperty
static final class	CfnWorkGroup.EngineConfigurationProperty.Jsii$Proxy	An implementation for CfnWorkGroup.EngineConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnWorkGroup.EngineConfigurationProperty.Builder	builder()
default Object	getAdditionalConfigs()	Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs.
default Object	getClassifications()	The configuration classifications that can be specified for the engine.
default Number	getCoordinatorDpuSize()	The number of DPUs to use for the coordinator.
default Number	getDefaultExecutorDpuSize()	The default number of DPUs to use for executors.
default Number	getMaxConcurrentDpus()	The maximum number of DPUs that can run concurrently.
default Object	getSparkProperties()	Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalConfigs

@Stability(Stable)
@Nullable
default Object getAdditionalConfigs()

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.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getClassifications

@Stability(Stable)
@Nullable
default Object getClassifications()

The configuration classifications that can be specified for the engine.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWorkGroup.ClassificationProperty>

See Also:

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

getCoordinatorDpuSize

@Stability(Stable)
@Nullable
default Number getCoordinatorDpuSize()

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.

See Also:

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

getDefaultExecutorDpuSize

@Stability(Stable)
@Nullable
default Number getDefaultExecutorDpuSize()

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.

See Also:

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

getMaxConcurrentDpus

@Stability(Stable)
@Nullable
default Number getMaxConcurrentDpus()

The maximum number of DPUs that can run concurrently.

See Also:

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

getSparkProperties

@Stability(Stable)
@Nullable
default Object getSparkProperties()

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

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

builder

@Stability(Stable)
static CfnWorkGroup.EngineConfigurationProperty.Builder builder()

Returns:

a CfnWorkGroup.EngineConfigurationProperty.Builder of CfnWorkGroup.EngineConfigurationProperty