Package software.amazon.awscdk.services.athena

Interface CfnSessionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSessionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:50:57.164Z")
@Stability(Stable)
public interface CfnSessionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSession.

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.*;
 CfnSessionProps cfnSessionProps = CfnSessionProps.builder()
         .engineConfiguration(EngineConfigurationProperty.builder()
                 .maxConcurrentDpus(123)
                 // the properties below are optional
                 .additionalConfigs(Map.of(
                         "additionalConfigsKey", "additionalConfigs"))
                 .coordinatorDpuSize(123)
                 .defaultExecutorDpuSize(123)
                 .sparkProperties(Map.of(
                         "sparkPropertiesKey", "sparkProperties"))
                 .build())
         .workGroup("workGroup")
         // the properties below are optional
         .executionRole("executionRole")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-session.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSessionProps.Builder	builder()
Object	getEngineConfiguration()	Contains engine data processing unit (DPU) configuration settings.
default String	getExecutionRole()	The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups.
String	getWorkGroup()	The workgroup to which the session belongs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEngineConfiguration

@Stability(Stable)
@NotNull
Object getEngineConfiguration()

Contains engine data processing unit (DPU) configuration settings.

Returns union: either IResolvable or CfnSession.EngineConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-session.html#cfn-athena-session-engineconfiguration

getWorkGroup

@Stability(Stable)
@NotNull
String getWorkGroup()

The workgroup to which the session belongs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-session.html#cfn-athena-session-workgroup

getExecutionRole

@Stability(Stable)
@Nullable
default String getExecutionRole()

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-session.html#cfn-athena-session-executionrole

builder

@Stability(Stable)
static CfnSessionProps.Builder builder()

Returns:

a CfnSessionProps.Builder of CfnSessionProps