AWS CDK Reference

Appearance

v2.273.0

CfnDevEndpointProps Struct ​

Properties for defining a CfnDevEndpoint.

Source
Generated code

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';

declare const arguments_: any;
declare const tags: any;
const cfnDevEndpointProps: glue.CfnDevEndpointProps = {
  roleArn: 'roleArn',

  // the properties below are optional
  arguments: arguments_,
  endpointName: 'endpointName',
  extraJarsS3Path: 'extraJarsS3Path',
  extraPythonLibsS3Path: 'extraPythonLibsS3Path',
  glueVersion: 'glueVersion',
  numberOfNodes: 123,
  numberOfWorkers: 123,
  publicKey: 'publicKey',
  publicKeys: ['publicKeys'],
  securityConfiguration: 'securityConfiguration',
  securityGroupIds: ['securityGroupIds'],
  subnetId: 'subnetId',
  tags: tags,
  workerType: 'workerType',
};

Properties ​

argumentsanyargumentsAnyargumentsObjectArgumentsobjectArgumentsinterface{}#
A map of arguments used to configure the `DevEndpoint` .
notes

Valid arguments are:

  • "--enable-glue-datacatalog": ""
  • "GLUE_PYTHON_VERSION": "3"
  • "GLUE_PYTHON_VERSION": "2"

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.

endpointNamestringendpoint_namestrendpointNameStringEndpointNamestringEndpointName*string#
The name of the `DevEndpoint` .
extraJarsS3Pathstringextra_jars_s3_pathstrextraJarsS3PathStringExtraJarsS3PathstringExtraJarsS3Path*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 .

extraPythonLibsS3Pathstringextra_python_libs_s3_pathstrextraPythonLibsS3PathStringExtraPythonLibsS3PathstringExtraPythonLibsS3Path*string#
The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your `DevEndpoint` .
notes

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.

glueVersionstringglue_versionstrglueVersionStringGlueVersionstringGlueVersion*string#
The AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
notes

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.

numberOfNodesnumbernumber_of_nodesint | floatnumberOfNodesNumberNumberOfNodesdoubleNumberOfNodes*float64#
The number of AWS Glue Data Processing Units (DPUs) allocated to this `DevEndpoint` .
numberOfWorkersnumbernumber_of_workersint | floatnumberOfWorkersNumberNumberOfWorkersdoubleNumberOfWorkers*float64#
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 .

publicKeystringpublic_keystrpublicKeyStringPublicKeystringPublicKey*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.

publicKeysstring[]public_keystyping.List[str]publicKeysList<String>PublicKeysstring[]PublicKeys*[]*string#
A list of public keys to be used by the `DevEndpoints` for authentication.
notes

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.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#
The Amazon Resource Name (ARN) of the IAM role used in this `DevEndpoint` .
securityConfigurationstringsecurity_configurationstrsecurityConfigurationStringSecurityConfigurationstringSecurityConfiguration*string#
The name of the `SecurityConfiguration` structure to be used with this `DevEndpoint` .
securityGroupIdsstring[]security_group_idstyping.List[str]securityGroupIdsList<String>SecurityGroupIdsstring[]SecurityGroupIds*[]*string#
A list of security group identifiers used in this `DevEndpoint` .
subnetIdstringsubnet_idstrsubnetIdStringSubnetIdstringSubnetId*string#
The subnet ID for this `DevEndpoint` .
tagsanytagsAnytagsObjectTagsobjectTagsinterface{}#
The tags to use with this DevEndpoint.
workerTypestringworker_typestrworkerTypeStringWorkerTypestringWorkerType*string#
The type of predefined worker that is allocated to the development endpoint.
notes

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.

Used as props by ​