Class: Aws::Glue::Types::CreateSessionRequest

Inherits:

Struct

• Object
• Struct
• Aws::Glue::Types::CreateSessionRequest

Defined in:

gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Request to create a new session.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #command ⇒ Types::SessionCommand

  The SessionCommand that runs the job.

• #connections ⇒ Types::ConnectionsList

  The number of connections to use for the session.

• #default_arguments ⇒ Hash<String,String>

  A map array of key-value pairs.

• #description ⇒ String

  The description of the session.

• #glue_version ⇒ String

  The Glue version determines the versions of Apache Spark and Python that Glue supports.

• #id ⇒ String

  The ID of the session request.

• #idle_timeout ⇒ Integer

  The number of minutes when idle before session times out.

• #max_capacity ⇒ Float

  The number of Glue data processing units (DPUs) that can be allocated when the job runs.

• #number_of_workers ⇒ Integer

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

• #request_origin ⇒ String

  The origin of the request.

• #role ⇒ String

  The IAM Role ARN.

• #security_configuration ⇒ String

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

• #session_type ⇒ String

  The type of session to create.

• #tags ⇒ Hash<String,String>

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

• #timeout ⇒ Integer

  The number of minutes before session times out.

• #worker_type ⇒ String

  The type of predefined worker that is allocated when a job runs.

Instance Attribute Details

#command ⇒ Types::SessionCommand

The SessionCommand that runs the job.

Returns:

• (Types::SessionCommand)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#connections ⇒ Types::ConnectionsList

The number of connections to use for the session.

Returns:

• (Types::ConnectionsList)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#default_arguments ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the session.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#glue_version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the session request.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#idle_timeout ⇒ Integer

The number of minutes when idle before session times out. Default for Spark ETL jobs is value of Timeout. Consult the documentation for other job types.

Returns:

• (Integer)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacity ⇒ Float

The number of 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.

Returns:

• (Float)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_workers ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#request_origin ⇒ String

The origin of the request.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ String

The IAM Role ARN

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#security_configuration ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#session_type ⇒ String

The type of session to create.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end

#worker_type ⇒ String

The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X, G.12X, G.16X, R.1X, R.2X, R.4X, or R.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.

• For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

• For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

• For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in select Amazon Web Services Regions. For the supported Regions, see Configuring job properties for Spark jobs in the developer guide.

• For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in select Amazon Web Services Regions. For the supported Regions, see Configuring job properties for Spark jobs in the developer guide.

• For the G.12X worker type, each worker maps to 12 DPU (48 vCPUs, 192 GB of memory) with 768GB disk, and provides 1 executor per worker. We recommend this worker type for jobs with very large workloads. This worker type is available only for Glue version 4.0 or later Spark ETL jobs in select Amazon Web Services Regions. For the supported Regions, see Configuring job properties for Spark jobs in the developer guide.

• For the G.16X worker type, each worker maps to 16 DPU (64 vCPUs, 256 GB of memory) with 1024GB disk, and provides 1 executor per worker. We recommend this worker type for jobs with very large workloads. This worker type is available only for Glue version 4.0 or later Spark ETL jobs in select Amazon Web Services Regions. For the supported Regions, see Configuring job properties for Spark jobs in the developer guide.

• For the R.1X worker type, each worker maps to 1 M-DPU (4 vCPUs, 32 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for memory-intensive workloads. This worker type is available only for Glue version 4.0 or later Spark ETL jobs in select Amazon Web Services Regions. For the supported Regions, see Configuring job properties for Spark jobs in the developer guide.

• For the R.2X worker type, each worker maps to 2 M-DPU (8 vCPUs, 64 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for memory-intensive workloads. This worker type is available only for Glue version 4.0 or later Spark ETL jobs in select Amazon Web Services Regions. For the supported Regions, see Configuring job properties for Spark jobs in the developer guide.

• For the R.4X worker type, each worker maps to 4 M-DPU (16 vCPUs, 128 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for memory-intensive workloads. This worker type is available only for Glue version 4.0 or later Spark ETL jobs in select Amazon Web Services Regions. For the supported Regions, see Configuring job properties for Spark jobs in the developer guide.

• For the R.8X worker type, each worker maps to 8 M-DPU (32 vCPUs, 256 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for memory-intensive workloads. This worker type is available only for Glue version 4.0 or later Spark ETL jobs in select Amazon Web Services Regions. For the supported Regions, see Configuring job properties for Spark jobs in the developer guide.

• For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 7980

class CreateSessionRequest < Struct.new(
  :id,
  :description,
  :role,
  :command,
  :timeout,
  :idle_timeout,
  :default_arguments,
  :connections,
  :max_capacity,
  :number_of_workers,
  :worker_type,
  :security_configuration,
  :glue_version,
  :tags,
  :request_origin,
  :session_type)
  SENSITIVE = []
  include Aws::Structure
end