dev_endpoints
Creates, updates, deletes, gets or lists a dev_endpoints resource.
Overview
| Name | dev_endpoints |
| Type | Resource |
| Id | aws.glue.dev_endpoints |
Fields
The following fields are returned by SELECT queries:
- batch_get_dev_endpoints
- get_dev_endpoint
- get_dev_endpoints
| Name | Datatype | Description |
|---|---|---|
dev_endpoints | array | A list of DevEndpoint definitions. |
dev_endpoints_not_found | array | A list of DevEndpoints not found. |
| Name | Datatype | Description |
|---|---|---|
arguments | object | A map of arguments used to configure the DevEndpoint. Valid arguments are: "--enable-glue-datacatalog": "" 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. |
availability_zone | string | The Amazon Web Services Availability Zone where this DevEndpoint is located. |
created_timestamp | string (date-time) | The point in time at which this DevEndpoint was created. |
endpoint_name | string | The name of the DevEndpoint. |
extra_jars_s3_path | string | The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint. You can only use pure Java/Scala libraries with a DevEndpoint. |
extra_python_libs_s3_path | string | 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 currently supported. |
failure_reason | string | The reason for a current failure in this DevEndpoint. |
glue_version | string | Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints. For more information about the available 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. (pattern: <code>^(\w+.)+\w+$</code>) |
last_modified_timestamp | string (date-time) | The point in time at which this DevEndpoint was last modified. |
last_update_status | string | The status of the last update. |
number_of_nodes | integer | The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint. |
number_of_workers | integer | 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. |
private_address | string | A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC. |
public_address | string | The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint. |
public_key | string | 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. |
public_keys | array | A list of public keys to be used by the DevEndpoints for authentication. Using 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 operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute. |
role_arn | string | The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint. (pattern: <code>arn:aws:iam::\d{12}:role/.*</code>) |
security_configuration | string | The name of the SecurityConfiguration structure to be used with this DevEndpoint. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>) |
security_group_ids | array | A list of security group identifiers used in this DevEndpoint. |
status | string | The current status of this DevEndpoint. |
subnet_id | string | The subnet ID for this DevEndpoint. |
vpc_id | string | The ID of the virtual private cloud (VPC) used by this DevEndpoint. |
worker_type | string | 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. (Standard, G.1X, G.2X, G.025X, G.4X, G.8X, Z.2X) |
yarn_endpoint_address | string | The YARN endpoint address used by this DevEndpoint. |
zeppelin_remote_spark_interpreter_port | integer | The Apache Zeppelin port for the remote Apache Spark interpreter. |
| Name | Datatype | Description |
|---|---|---|
arguments | object | A map of arguments used to configure the DevEndpoint. Valid arguments are: "--enable-glue-datacatalog": "" 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. |
availability_zone | string | The Amazon Web Services Availability Zone where this DevEndpoint is located. |
created_timestamp | string (date-time) | The point in time at which this DevEndpoint was created. |
endpoint_name | string | The name of the DevEndpoint. |
extra_jars_s3_path | string | The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint. You can only use pure Java/Scala libraries with a DevEndpoint. |
extra_python_libs_s3_path | string | 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 currently supported. |
failure_reason | string | The reason for a current failure in this DevEndpoint. |
glue_version | string | Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints. For more information about the available 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. (pattern: <code>^(\w+.)+\w+$</code>) |
last_modified_timestamp | string (date-time) | The point in time at which this DevEndpoint was last modified. |
last_update_status | string | The status of the last update. |
number_of_nodes | integer | The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint. |
number_of_workers | integer | 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. |
private_address | string | A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC. |
public_address | string | The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint. |
public_key | string | 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. |
public_keys | array | A list of public keys to be used by the DevEndpoints for authentication. Using 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 operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute. |
role_arn | string | The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint. (pattern: <code>arn:aws:iam::\d{12}:role/.*</code>) |
security_configuration | string | The name of the SecurityConfiguration structure to be used with this DevEndpoint. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>) |
security_group_ids | array | A list of security group identifiers used in this DevEndpoint. |
status | string | The current status of this DevEndpoint. |
subnet_id | string | The subnet ID for this DevEndpoint. |
vpc_id | string | The ID of the virtual private cloud (VPC) used by this DevEndpoint. |
worker_type | string | 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. (Standard, G.1X, G.2X, G.025X, G.4X, G.8X, Z.2X) |
yarn_endpoint_address | string | The YARN endpoint address used by this DevEndpoint. |
zeppelin_remote_spark_interpreter_port | integer | The Apache Zeppelin port for the remote Apache Spark interpreter. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
batch_get_dev_endpoints | select | region | Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. | |
get_dev_endpoint | select | region | Retrieves information about a specified development endpoint. When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address. | |
get_dev_endpoints | select | region | Retrieves all the development endpoints in this Amazon Web Services account. When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address. | |
create_dev_endpoint | insert | region, EndpointName, RoleArn | Creates a new development endpoint. | |
update_dev_endpoint | update | region, EndpointName | Updates a specified development endpoint. | |
delete_dev_endpoint | delete | region | Deletes a specified development endpoint. | |
list_dev_endpoints | exec | region | Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- batch_get_dev_endpoints
- get_dev_endpoint
- get_dev_endpoints
Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
SELECT
dev_endpoints,
dev_endpoints_not_found
FROM aws.glue.dev_endpoints
WHERE region = '{{ region }}' -- required
;
Retrieves information about a specified development endpoint. When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
SELECT
arguments,
availability_zone,
created_timestamp,
endpoint_name,
extra_jars_s3_path,
extra_python_libs_s3_path,
failure_reason,
glue_version,
last_modified_timestamp,
last_update_status,
number_of_nodes,
number_of_workers,
private_address,
public_address,
public_key,
public_keys,
role_arn,
security_configuration,
security_group_ids,
status,
subnet_id,
vpc_id,
worker_type,
yarn_endpoint_address,
zeppelin_remote_spark_interpreter_port
FROM aws.glue.dev_endpoints
WHERE region = '{{ region }}' -- required
;
Retrieves all the development endpoints in this Amazon Web Services account. When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, Glue returns only a public IP address.
SELECT
arguments,
availability_zone,
created_timestamp,
endpoint_name,
extra_jars_s3_path,
extra_python_libs_s3_path,
failure_reason,
glue_version,
last_modified_timestamp,
last_update_status,
number_of_nodes,
number_of_workers,
private_address,
public_address,
public_key,
public_keys,
role_arn,
security_configuration,
security_group_ids,
status,
subnet_id,
vpc_id,
worker_type,
yarn_endpoint_address,
zeppelin_remote_spark_interpreter_port
FROM aws.glue.dev_endpoints
WHERE region = '{{ region }}' -- required
;
INSERT examples
- create_dev_endpoint
- Manifest
Creates a new development endpoint.
INSERT INTO aws.glue.dev_endpoints (
EndpointName,
RoleArn,
SecurityGroupIds,
SubnetId,
PublicKey,
PublicKeys,
NumberOfNodes,
WorkerType,
GlueVersion,
NumberOfWorkers,
ExtraPythonLibsS3Path,
ExtraJarsS3Path,
SecurityConfiguration,
Tags,
Arguments,
region
)
SELECT
'{{ EndpointName }}' /* required */,
'{{ RoleArn }}' /* required */,
'{{ SecurityGroupIds }}',
'{{ SubnetId }}',
'{{ PublicKey }}',
'{{ PublicKeys }}',
{{ NumberOfNodes }},
'{{ WorkerType }}',
'{{ GlueVersion }}',
{{ NumberOfWorkers }},
'{{ ExtraPythonLibsS3Path }}',
'{{ ExtraJarsS3Path }}',
'{{ SecurityConfiguration }}',
'{{ Tags }}',
'{{ Arguments }}',
'{{ region }}'
RETURNING
arguments,
availability_zone,
created_timestamp,
endpoint_name,
extra_jars_s3_path,
extra_python_libs_s3_path,
failure_reason,
glue_version,
number_of_nodes,
number_of_workers,
role_arn,
security_configuration,
security_group_ids,
status,
subnet_id,
vpc_id,
worker_type,
yarn_endpoint_address,
zeppelin_remote_spark_interpreter_port
;
# Description fields are for documentation purposes
- name: dev_endpoints
props:
- name: region
value: "{{ region }}"
description: Required parameter for the dev_endpoints resource.
- name: EndpointName
value: "{{ EndpointName }}"
description: |
The name to be assigned to the new DevEndpoint.
- name: RoleArn
value: "{{ RoleArn }}"
description: |
The IAM role for the DevEndpoint.
- name: SecurityGroupIds
value:
- "{{ SecurityGroupIds }}"
description: |
Security group IDs for the security groups to be used by the new DevEndpoint.
- name: SubnetId
value: "{{ SubnetId }}"
description: |
The subnet ID for the new DevEndpoint to use.
- name: PublicKey
value: "{{ PublicKey }}"
description: |
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.
- name: PublicKeys
value:
- "{{ PublicKeys }}"
description: |
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.
- name: NumberOfNodes
value: {{ NumberOfNodes }}
description: |
The number of Glue Data Processing Units (DPUs) to allocate to this DevEndpoint.
- name: WorkerType
value: "{{ WorkerType }}"
description: |
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.
valid_values: ['Standard', 'G.1X', 'G.2X', 'G.025X', 'G.4X', 'G.8X', 'Z.2X']
- name: GlueVersion
value: "{{ GlueVersion }}"
description: |
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints. For more information about the available 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.
- name: NumberOfWorkers
value: {{ NumberOfWorkers }}
description: |
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.
- name: ExtraPythonLibsS3Path
value: "{{ ExtraPythonLibsS3Path }}"
description: |
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.
- name: ExtraJarsS3Path
value: "{{ ExtraJarsS3Path }}"
description: |
The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.
- name: SecurityConfiguration
value: "{{ SecurityConfiguration }}"
description: |
The name of the SecurityConfiguration structure to be used with this DevEndpoint.
- name: Tags
value: "{{ Tags }}"
description: |
The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
- name: Arguments
value: "{{ Arguments }}"
description: |
A map of arguments used to configure the DevEndpoint.
UPDATE examples
- update_dev_endpoint
Updates a specified development endpoint.
UPDATE aws.glue.dev_endpoints
SET
EndpointName = '{{ EndpointName }}',
PublicKey = '{{ PublicKey }}',
AddPublicKeys = '{{ AddPublicKeys }}',
DeletePublicKeys = '{{ DeletePublicKeys }}',
CustomLibraries = '{{ CustomLibraries }}',
UpdateEtlLibraries = {{ UpdateEtlLibraries }},
DeleteArguments = '{{ DeleteArguments }}',
AddArguments = '{{ AddArguments }}'
WHERE
region = '{{ region }}' --required
AND EndpointName = '{{ EndpointName }}' --required;
DELETE examples
- delete_dev_endpoint
Deletes a specified development endpoint.
DELETE FROM aws.glue.dev_endpoints
WHERE region = '{{ region }}' --required
;
Lifecycle Methods
- list_dev_endpoints
Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
EXEC aws.glue.dev_endpoints.list_dev_endpoints
@region='{{ region }}' --required
@@json=
'{
"NextToken": "{{ NextToken }}",
"MaxResults": {{ MaxResults }},
"Tags": "{{ Tags }}"
}'
;