This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.
AWS::Glue::Session
The period in which a remote Spark runtime environment is running.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Glue::Session", "Properties" : { "Command" :SessionCommand, "Connections" :ConnectionsList, "DefaultArguments" :{, "Description" :Key:Value, ...}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:SessionCommandConnections:ConnectionsListDefaultArguments:Description:Key:ValueStringGlueVersion:StringId:StringIdleTimeout:IntegerMaxCapacity:NumberNumberOfWorkers:IntegerRequestOrigin:StringRole:StringSecurityConfiguration:StringTags:- TagTimeout:IntegerWorkerType: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:
0Maximum:
4096Update 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:
0Maximum:
2048Update requires: Replacement
GlueVersion-
The Amazon Glue version determines the versions of Apache Spark and Python that Amazon Glue supports. The GlueVersion must be greater than 2.0.
Required: No
Type: String
Pattern:
^(\w+\.)+\w+$Minimum:
1Maximum:
255Update requires: Replacement
Id-
The ID of the session.
Required: Yes
Type: String
Pattern:
^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*$Minimum:
1Maximum:
255Update 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 Amazon 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
WorkerTypeto 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:
1Maximum:
128Update 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:
20Maximum:
2048Update 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:
1Maximum:
255Update requires: Replacement
-
The map of key value pairs (tags) belonging to the session.
Required: No
Type: Array of Tag
Minimum:
0Maximum:
50Update 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:
1Update 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,G.8X,G.12X,G.16X,R.1X,R.2X,R.4X, orR.8Xfor Spark sessions. Accepts the valueZ.2Xfor Ray sessions.The
G.12X,G.16X, andR.1XthroughR.8Xworker types are available only for Amazon Glue version 4.0 or later Spark ETL jobs in select Amazon Regions. For the supported Regions, see Configuring job properties for Spark jobs in the developer guide.Required: No
Type: String
Allowed values:
Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.2XUpdate requires: Replacement
Return values
Ref
Fn::GetAtt
ArnProperty 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.