Package software.amazon.awscdk.services.glue

Interface CfnDevEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDevEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:02.445Z")
@Stability(Stable)
public interface CfnDevEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDevEndpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Object arguments_;
 Object tags;
 CfnDevEndpointProps cfnDevEndpointProps = CfnDevEndpointProps.builder()
         .roleArn("roleArn")
         // the properties below are optional
         .arguments(arguments_)
         .endpointName("endpointName")
         .extraJarsS3Path("extraJarsS3Path")
         .extraPythonLibsS3Path("extraPythonLibsS3Path")
         .glueVersion("glueVersion")
         .numberOfNodes(123)
         .numberOfWorkers(123)
         .publicKey("publicKey")
         .publicKeys(List.of("publicKeys"))
         .securityConfiguration("securityConfiguration")
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetId("subnetId")
         .tags(tags)
         .workerType("workerType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDevEndpointProps.Builder	A builder for CfnDevEndpointProps
static final class	CfnDevEndpointProps.Jsii$Proxy	An implementation for CfnDevEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnDevEndpointProps.Builder	builder()
default Object	getArguments()	A map of arguments used to configure the DevEndpoint .
default String	getEndpointName()	The name of the DevEndpoint .
default String	getExtraJarsS3Path()	The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint .
default String	getExtraPythonLibsS3Path()	The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint .
default String	getGlueVersion()	The AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
default Number	getNumberOfNodes()	The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint .
default Number	getNumberOfWorkers()	The number of workers of a defined workerType that are allocated to the development endpoint.
default String	getPublicKey()	The public key to be used by this DevEndpoint for authentication.
default List<String>	getPublicKeys()	A list of public keys to be used by the DevEndpoints for authentication.
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .
default String	getSecurityConfiguration()	The name of the SecurityConfiguration structure to be used with this DevEndpoint .
default List<String>	getSecurityGroupIds()	A list of security group identifiers used in this DevEndpoint .
default String	getSubnetId()	The subnet ID for this DevEndpoint .
default Object	getTags()	The tags to use with this DevEndpoint.
default String	getWorkerType()	The type of predefined worker that is allocated to the development endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-rolearn

getArguments

@Stability(Stable)
@Nullable
default Object getArguments()

A map of arguments used to configure the DevEndpoint .

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-arguments

getEndpointName

@Stability(Stable)
@Nullable
default String getEndpointName()

The name of the DevEndpoint .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-endpointname

getExtraJarsS3Path

@Stability(Stable)
@Nullable
default String getExtraJarsS3Path()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-extrajarss3path

getExtraPythonLibsS3Path

@Stability(Stable)
@Nullable
default String getExtraPythonLibsS3Path()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-extrapythonlibss3path

getGlueVersion

@Stability(Stable)
@Nullable
default String getGlueVersion()

The AWS 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-glueversion

getNumberOfNodes

@Stability(Stable)
@Nullable
default Number getNumberOfNodes()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-numberofnodes

getNumberOfWorkers

@Stability(Stable)
@Nullable
default Number getNumberOfWorkers()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-numberofworkers

getPublicKey

@Stability(Stable)
@Nullable
default String getPublicKey()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-publickey

getPublicKeys

@Stability(Stable)
@Nullable
default List<String> getPublicKeys()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-publickeys

getSecurityConfiguration

@Stability(Stable)
@Nullable
default String getSecurityConfiguration()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-securityconfiguration

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getSecurityGroupIds()

A list of security group identifiers used in this DevEndpoint .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-securitygroupids

getSubnetId

@Stability(Stable)
@Nullable
default String getSubnetId()

The subnet ID for this DevEndpoint .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-subnetid

getTags

@Stability(Stable)
@Nullable
default Object getTags()

The tags to use with this DevEndpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-tags

getWorkerType

@Stability(Stable)
@Nullable
default String getWorkerType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-workertype

builder

@Stability(Stable)
static CfnDevEndpointProps.Builder builder()

Returns:

a CfnDevEndpointProps.Builder of CfnDevEndpointProps