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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default CreateSessionRequest.Buildercommand(Consumer<SessionCommand.Builder> command)TheSessionCommandthat runs the job.CreateSessionRequest.Buildercommand(SessionCommand command)TheSessionCommandthat runs the job.default CreateSessionRequest.Builderconnections(Consumer<ConnectionsList.Builder> connections)The number of connections to use for the session.CreateSessionRequest.Builderconnections(ConnectionsList connections)The number of connections to use for the session.CreateSessionRequest.BuilderdefaultArguments(Map<String,String> defaultArguments)A map array of key-value pairs.CreateSessionRequest.Builderdescription(String description)The description of the session.CreateSessionRequest.BuilderglueVersion(String glueVersion)The Glue version determines the versions of Apache Spark and Python that Glue supports.CreateSessionRequest.Builderid(String id)The ID of the session request.CreateSessionRequest.BuilderidleTimeout(Integer idleTimeout)The number of minutes when idle before session times out.CreateSessionRequest.BuildermaxCapacity(Double maxCapacity)The number of Glue data processing units (DPUs) that can be allocated when the job runs.CreateSessionRequest.BuildernumberOfWorkers(Integer numberOfWorkers)The number of workers of a definedWorkerTypeto use for the session.CreateSessionRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateSessionRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateSessionRequest.BuilderrequestOrigin(String requestOrigin)The origin of the request.CreateSessionRequest.Builderrole(String role)The IAM Role ARNCreateSessionRequest.BuildersecurityConfiguration(String securityConfiguration)The name of the SecurityConfiguration structure to be used with the sessionCreateSessionRequest.Buildertags(Map<String,String> tags)The map of key value pairs (tags) belonging to the session.CreateSessionRequest.Buildertimeout(Integer timeout)The number of minutes before session times out.CreateSessionRequest.BuilderworkerType(String workerType)The type of predefined worker that is allocated when a job runs.CreateSessionRequest.BuilderworkerType(WorkerType workerType)The type of predefined worker that is allocated when a job runs.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.glue.model.GlueRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
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
SessionCommandthat runs the job.- Parameters:
command- TheSessionCommandthat 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
This is a convenience method that creates an instance of theSessionCommandthat runs the job.SessionCommand.Builderavoiding the need to create one manually viaSessionCommand.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocommand(SessionCommand).- Parameters:
command- a consumer that will call methods onSessionCommand.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
command(SessionCommand)
-
timeout
CreateSessionRequest.Builder timeout(Integer 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.
- Parameters:
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.- 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 theConnectionsList.Builderavoiding the need to create one manually viaConnectionsList.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toconnections(ConnectionsList).- Parameters:
connections- a consumer that will call methods onConnectionsList.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
connections(ConnectionsList)
-
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
WorkerTypeto use for the session.- Parameters:
numberOfWorkers- The number of workers of a definedWorkerTypeto 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.1Xworker 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.2Xworker 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.4Xworker 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 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.8Xworker 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 the same Amazon Web Services Regions as supported for theG.4Xworker type. -
For the
Z.2Xworker 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.
- 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.1Xworker 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.2Xworker 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.4Xworker 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 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.8Xworker 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 the same Amazon Web Services Regions as supported for theG.4Xworker type. -
For the
Z.2Xworker 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorkerType,WorkerType
-
-
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.1Xworker 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.2Xworker 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.4Xworker 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 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.8Xworker 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 the same Amazon Web Services Regions as supported for theG.4Xworker type. -
For the
Z.2Xworker 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.
- 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.1Xworker 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.2Xworker 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.4Xworker 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 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.8Xworker 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 the same Amazon Web Services Regions as supported for theG.4Xworker type. -
For the
Z.2Xworker 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorkerType,WorkerType
-
-
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)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-