View a markdown version of this page

AWS::Glue::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::Glue::Session

The period in which a remote Spark runtime environment is running.

Syntax

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

JSON

{
  "Type" : "AWS::Glue::Session",
  "Properties" : {
      "Command" : SessionCommand,
      "Connections" : ConnectionsList,
      "DefaultArguments" : {Key: Value, ...},
      "Description" : String,
      "GlueVersion" : String,
      "Id" : String,
      "IdleTimeout" : Integer,
      "MaxCapacity" : Number,
      "NumberOfWorkers" : Integer,
      "RequestOrigin" : String,
      "Role" : String,
      "SecurityConfiguration" : String,
      "Tags" : [ Tag, ... ],
      "Timeout" : Integer,
      "WorkerType" : String
    }
}

YAML

Type: AWS::Glue::Session
Properties:
  Command: 
    SessionCommand
  Connections: 
    ConnectionsList
  DefaultArguments: 
    Key: Value
  Description: String
  GlueVersion: String
  Id: String
  IdleTimeout: Integer
  MaxCapacity: Number
  NumberOfWorkers: Integer
  RequestOrigin: String
  Role: String
  SecurityConfiguration: String
  Tags: 
    - Tag
  Timeout: Integer
  WorkerType: String

Properties

Command

The command object.See SessionCommand.

Required: Yes

Type: SessionCommand

Update requires: Replacement

Connections

The number of connections used for the session.

Required: No

Type: ConnectionsList

Update requires: Replacement

DefaultArguments

A map array of key-value pairs. Max is 75 pairs.

Required: No

Type: Object of String

Pattern: ^[.\-_A-Za-z0-9]+$

Minimum: 0

Maximum: 4096

Update requires: Replacement

Description

The description of the session.

Required: No

Type: String

Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*$

Minimum: 0

Maximum: 2048

Update requires: Replacement

GlueVersion

The AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The GlueVersion must be greater than 2.0.

Required: No

Type: String

Pattern: ^(\w+\.)+\w+$

Minimum: 1

Maximum: 255

Update requires: Replacement

Id

The ID of the session.

Required: Yes

Type: String

Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*$

Minimum: 1

Maximum: 255

Update requires: Replacement

IdleTimeout

The number of minutes when idle before the session times out.

Required: No

Type: Integer

Update requires: Replacement

MaxCapacity

The number of AWS Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.

Required: No

Type: Number

Update requires: Replacement

NumberOfWorkers

The number of workers of a defined WorkerType to use for the session.

Required: No

Type: Integer

Update requires: Replacement

RequestOrigin

The origin of the request.

Required: No

Type: String

Pattern: ^[.\-_A-Za-z0-9]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

Role

The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.

Required: Yes

Type: String

Pattern: ^arn:aws[^:]*:iam::[0-9]*:role/.+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

SecurityConfiguration

The name of the SecurityConfiguration structure to be used with the session.

Required: No

Type: String

Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*$

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

The map of key value pairs (tags) belonging to the session.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Timeout

The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes). Consult the documentation for other job types.

Required: No

Type: Integer

Minimum: 1

Update requires: Replacement

WorkerType

The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark sessions. Accepts the value Z.2X for Ray sessions.

Required: No

Type: String

Allowed values: Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.2X

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

CreatedOn

The time and date when the session was created.

Progress

The code execution progress of the session.

Status

The session status.