View a markdown version of this page

AWS::Athena::Session - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::Athena::Session

The AWS::Athena::Session resource Property description not available. for Athena.

Syntax

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

JSON

{
  "Type" : "AWS::Athena::Session",
  "Properties" : {
      "EngineConfiguration" : EngineConfiguration,
      "ExecutionRole" : String,
      "WorkGroup" : String
    }
}

YAML

Type: AWS::Athena::Session
Properties:
  EngineConfiguration: 
    EngineConfiguration
  ExecutionRole: String
  WorkGroup: String

Properties

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.

Required: Yes

Type: EngineConfiguration

Update requires: Replacement

ExecutionRole

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

Required: No

Type: String

Minimum: 20

Maximum: 2048

Update requires: Replacement

WorkGroup

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9._-]{1,128}$

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

EngineVersion

The engine version used by the session (for example, PySpark engine version 3).

SessionId

The session ID.