Package software.amazon.awssdk.services.glue.model

Interface CreateSessionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateSessionRequest.Builder,CreateSessionRequest>, GlueRequest.Builder, SdkBuilder<CreateSessionRequest.Builder,CreateSessionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateSessionRequest
public static interface CreateSessionRequest.Builder extends GlueRequest.Builder, SdkPojo, CopyableBuilder<CreateSessionRequest.Builder,CreateSessionRequest>

  • Method Details

    • id

      CreateSessionRequest.Builder id(String id)

      The ID of the session request.

      Parameters:
      id - The ID of the session request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateSessionRequest.Builder description(String description)

      The description of the session.

      Parameters:
      description - The description of the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • role

      CreateSessionRequest.Builder role(String role)

      The IAM Role ARN

      Parameters:
      role - The IAM Role ARN
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • command

      CreateSessionRequest.Builder command(SessionCommand command)

      The SessionCommand that runs the job.

      Parameters:
      command - The SessionCommand that runs the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • command

      default CreateSessionRequest.Builder command(Consumer<SessionCommand.Builder> command)

      The SessionCommand that runs the job.

      This is a convenience method that creates an instance of the SessionCommand.Builder avoiding the need to create one manually via SessionCommand.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to command(SessionCommand).

      Parameters:
      command - a consumer that will call methods on SessionCommand.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeout

      CreateSessionRequest.Builder timeout(Integer timeout)

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

      Parameters:
      timeout - The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult the documentation for other job types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idleTimeout

      CreateSessionRequest.Builder idleTimeout(Integer idleTimeout)

      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.

      Parameters:
      idleTimeout - 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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultArguments

      CreateSessionRequest.Builder defaultArguments(Map<String,String> defaultArguments)

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

      Parameters:
      defaultArguments - A map array of key-value pairs. Max is 75 pairs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connections

      CreateSessionRequest.Builder connections(ConnectionsList connections)

      The number of connections to use for the session.

      Parameters:
      connections - The number of connections to use for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connections

      default CreateSessionRequest.Builder connections(Consumer<ConnectionsList.Builder> connections)

      The number of connections to use for the session.

      This is a convenience method that creates an instance of the ConnectionsList.Builder avoiding the need to create one manually via ConnectionsList.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to connections(ConnectionsList).

      Parameters:
      connections - a consumer that will call methods on ConnectionsList.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxCapacity

      CreateSessionRequest.Builder maxCapacity(Double maxCapacity)

      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.

      Parameters:
      maxCapacity - 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:
      Returns a reference to this object so that method calls can be chained together.

    • numberOfWorkers

      CreateSessionRequest.Builder numberOfWorkers(Integer numberOfWorkers)

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

      Parameters:
      numberOfWorkers - The number of workers of a defined WorkerType to use for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workerType

      CreateSessionRequest.Builder workerType(String workerType)

      The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, or G.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 84GB disk (approximately 34GB free), 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 128GB disk (approximately 77GB free), 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 (approximately 235GB free), 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 the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).

      • For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), 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 the same Amazon Web Services Regions as supported for the G.4X worker type.

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

      Parameters:
      workerType - The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, or G.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 84GB disk (approximately 34GB free), 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 128GB disk (approximately 77GB free), 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 (approximately 235GB free), 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 the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).

      • For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), 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 the same Amazon Web Services Regions as supported for the G.4X worker type.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workerType

      CreateSessionRequest.Builder workerType(WorkerType workerType)

      The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, or G.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 84GB disk (approximately 34GB free), 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 128GB disk (approximately 77GB free), 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 (approximately 235GB free), 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 the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).

      • For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), 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 the same Amazon Web Services Regions as supported for the G.4X worker type.

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

      Parameters:
      workerType - The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, or G.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 84GB disk (approximately 34GB free), 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 128GB disk (approximately 77GB free), 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 (approximately 235GB free), 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 the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).

      • For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), 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 the same Amazon Web Services Regions as supported for the G.4X worker type.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • securityConfiguration

      CreateSessionRequest.Builder securityConfiguration(String securityConfiguration)

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

      Parameters:
      securityConfiguration - The name of the SecurityConfiguration structure to be used with the session
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • glueVersion

      CreateSessionRequest.Builder glueVersion(String glueVersion)

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

      Parameters:
      glueVersion - The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateSessionRequest.Builder tags(Map<String,String> tags)

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

      Parameters:
      tags - The map of key value pairs (tags) belonging to the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestOrigin

      CreateSessionRequest.Builder requestOrigin(String requestOrigin)

      The origin of the request.

      Parameters:
      requestOrigin - The origin of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.