You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Glue::Types::CreateDevEndpointRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Note:

When making an API call, you may pass CreateDevEndpointRequest data as a hash:

{
  endpoint_name: "GenericString", # required
  role_arn: "RoleArn", # required
  security_group_ids: ["GenericString"],
  subnet_id: "GenericString",
  public_key: "GenericString",
  public_keys: ["GenericString"],
  number_of_nodes: 1,
  worker_type: "Standard", # accepts Standard, G.1X, G.2X
  glue_version: "GlueVersionString",
  number_of_workers: 1,
  extra_python_libs_s3_path: "GenericString",
  extra_jars_s3_path: "GenericString",
  security_configuration: "NameString",
  tags: {
    "TagKey" => "TagValue",
  },
  arguments: {
    "GenericString" => "GenericString",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#argumentsHash<String,String>

A map of arguments used to configure the DevEndpoint.

Returns:

  • (Hash<String,String>)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#endpoint_nameString

The name to be assigned to the new DevEndpoint.

Returns:

  • (String)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#extra_jars_s3_pathString

The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.

Returns:

  • (String)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#extra_python_libs_s3_pathString

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

Returns:

  • (String)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#glue_versionString

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

Returns:

  • (String)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#number_of_nodesInteger

The number of AWS Glue Data Processing Units (DPUs) to allocate to this DevEndpoint.

Returns:

  • (Integer)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#number_of_workersInteger

The number of workers of a defined workerType that are allocated to the development endpoint.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

Returns:

  • (Integer)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#public_keyString

The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.

Returns:

  • (String)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#public_keysArray<String>

A list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.

Returns:

  • (Array<String>)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#role_arnString

The IAM role for the DevEndpoint.

Returns:

  • (String)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#security_configurationString

The name of the SecurityConfiguration structure to be used with this DevEndpoint.

Returns:

  • (String)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#security_group_idsArray<String>

Security group IDs for the security groups to be used by the new DevEndpoint.

Returns:

  • (Array<String>)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#subnet_idString

The subnet ID for the new DevEndpoint to use.

Returns:

  • (String)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#tagsHash<String,String>

The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Returns:

  • (Hash<String,String>)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end

#worker_typeString

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

Returns:

  • (String)


2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2254

class CreateDevEndpointRequest < Struct.new(
  :endpoint_name,
  :role_arn,
  :security_group_ids,
  :subnet_id,
  :public_key,
  :public_keys,
  :number_of_nodes,
  :worker_type,
  :glue_version,
  :number_of_workers,
  :extra_python_libs_s3_path,
  :extra_jars_s3_path,
  :security_configuration,
  :tags,
  :arguments)
  include Aws::Structure
end