CfnDevEndpoint

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.glue.CfnDevEndpoint

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.520Z")
public class CfnDevEndpoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Glue::DevEndpoint`.

The AWS::Glue::DevEndpoint resource specifies a development endpoint where a developer can remotely debug ETL scripts for AWS Glue . For more information, see DevEndpoint Structure in the AWS Glue Developer Guide.

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;
 CfnDevEndpoint cfnDevEndpoint = CfnDevEndpoint.Builder.create(this, "MyCfnDevEndpoint")
         .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();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnDevEndpoint.Builder
A fluent builder for CfnDevEndpoint.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnDevEndpoint.Builder` A fluent builder for `CfnDevEndpoint`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDevEndpoint(Construct scope, java.lang.String id, CfnDevEndpointProps props)` Create a new `AWS::Glue::DevEndpoint`.
`protected`	`CfnDevEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnDevEndpoint(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getArguments()` A map of arguments used to configure the `DevEndpoint` .
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getEndpointName()` The name of the `DevEndpoint` .
`java.lang.String`	`getExtraJarsS3Path()` The path to one or more Java `.jar` files in an S3 bucket that should be loaded in your `DevEndpoint` .
`java.lang.String`	`getExtraPythonLibsS3Path()` The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your `DevEndpoint` .
`java.lang.String`	`getGlueVersion()` The AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
`java.lang.Number`	`getNumberOfNodes()` The number of AWS Glue Data Processing Units (DPUs) allocated to this `DevEndpoint` .
`java.lang.Number`	`getNumberOfWorkers()` The number of workers of a defined `workerType` that are allocated to the development endpoint.
`java.lang.String`	`getPublicKey()` The public key to be used by this `DevEndpoint` for authentication.
`java.util.List<java.lang.String>`	`getPublicKeys()` A list of public keys to be used by the `DevEndpoints` for authentication.
`java.lang.String`	`getRoleArn()` The Amazon Resource Name (ARN) of the IAM role used in this `DevEndpoint` .
`java.lang.String`	`getSecurityConfiguration()` The name of the `SecurityConfiguration` structure to be used with this `DevEndpoint` .
`java.util.List<java.lang.String>`	`getSecurityGroupIds()` A list of security group identifiers used in this `DevEndpoint` .
`java.lang.String`	`getSubnetId()` The subnet ID for this `DevEndpoint` .
`TagManager`	`getTags()` The tags to use with this DevEndpoint.
`java.lang.String`	`getWorkerType()` The type of predefined worker that is allocated to the development endpoint.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setArguments(java.lang.Object value)` A map of arguments used to configure the `DevEndpoint` .
`void`	`setEndpointName(java.lang.String value)` The name of the `DevEndpoint` .
`void`	`setExtraJarsS3Path(java.lang.String value)` The path to one or more Java `.jar` files in an S3 bucket that should be loaded in your `DevEndpoint` .
`void`	`setExtraPythonLibsS3Path(java.lang.String value)` The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your `DevEndpoint` .
`void`	`setGlueVersion(java.lang.String value)` The AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
`void`	`setNumberOfNodes(java.lang.Number value)` The number of AWS Glue Data Processing Units (DPUs) allocated to this `DevEndpoint` .
`void`	`setNumberOfWorkers(java.lang.Number value)` The number of workers of a defined `workerType` that are allocated to the development endpoint.
`void`	`setPublicKey(java.lang.String value)` The public key to be used by this `DevEndpoint` for authentication.
`void`	`setPublicKeys(java.util.List<java.lang.String> value)` A list of public keys to be used by the `DevEndpoints` for authentication.
`void`	`setRoleArn(java.lang.String value)` The Amazon Resource Name (ARN) of the IAM role used in this `DevEndpoint` .
`void`	`setSecurityConfiguration(java.lang.String value)` The name of the `SecurityConfiguration` structure to be used with this `DevEndpoint` .
`void`	`setSecurityGroupIds(java.util.List<java.lang.String> value)` A list of security group identifiers used in this `DevEndpoint` .
`void`	`setSubnetId(java.lang.String value)` The subnet ID for this `DevEndpoint` .
`void`	`setWorkerType(java.lang.String value)` The type of predefined worker that is allocated to the development endpoint.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnDevEndpoint
```
protected CfnDevEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnDevEndpoint
```
protected CfnDevEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnDevEndpoint
```
public CfnDevEndpoint(Construct scope,
                      java.lang.String id,
                      CfnDevEndpointProps props)
```
    Create a new `AWS::Glue::DevEndpoint`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags to use with this DevEndpoint.
  - getArguments
```
public java.lang.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.
  - setArguments
```
public void setArguments(java.lang.Object value)
```
    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.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role used in this `DevEndpoint` .
  - setRoleArn
```
public void setRoleArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the IAM role used in this `DevEndpoint` .
  - getEndpointName
```
public java.lang.String getEndpointName()
```
    The name of the `DevEndpoint` .
  - setEndpointName
```
public void setEndpointName(java.lang.String value)
```
    The name of the `DevEndpoint` .
  - getExtraJarsS3Path
```
public java.lang.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 .
  - setExtraJarsS3Path
```
public void setExtraJarsS3Path(java.lang.String value)
```
    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 .
  - getExtraPythonLibsS3Path
```
public java.lang.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.
  - setExtraPythonLibsS3Path
```
public void setExtraPythonLibsS3Path(java.lang.String value)
```
    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.
  - getGlueVersion
```
public java.lang.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.
  - setGlueVersion
```
public void setGlueVersion(java.lang.String value)
```
    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.
  - getNumberOfNodes
```
public java.lang.Number getNumberOfNodes()
```
    The number of AWS Glue Data Processing Units (DPUs) allocated to this `DevEndpoint` .
  - setNumberOfNodes
```
public void setNumberOfNodes(java.lang.Number value)
```
    The number of AWS Glue Data Processing Units (DPUs) allocated to this `DevEndpoint` .
  - getNumberOfWorkers
```
public java.lang.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 .
  - setNumberOfWorkers
```
public void setNumberOfWorkers(java.lang.Number value)
```
    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 .
  - getPublicKey
```
public java.lang.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.
  - setPublicKey
```
public void setPublicKey(java.lang.String value)
```
    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.
  - getPublicKeys
```
public java.util.List<java.lang.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.
  - setPublicKeys
```
public void setPublicKeys(java.util.List<java.lang.String> value)
```
    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.
  - getSecurityConfiguration
```
public java.lang.String getSecurityConfiguration()
```
    The name of the `SecurityConfiguration` structure to be used with this `DevEndpoint` .
  - setSecurityConfiguration
```
public void setSecurityConfiguration(java.lang.String value)
```
    The name of the `SecurityConfiguration` structure to be used with this `DevEndpoint` .
  - getSecurityGroupIds
```
public java.util.List<java.lang.String> getSecurityGroupIds()
```
    A list of security group identifiers used in this `DevEndpoint` .
  - setSecurityGroupIds
```
public void setSecurityGroupIds(java.util.List<java.lang.String> value)
```
    A list of security group identifiers used in this `DevEndpoint` .
  - getSubnetId
```
public java.lang.String getSubnetId()
```
    The subnet ID for this `DevEndpoint` .
  - setSubnetId
```
public void setSubnetId(java.lang.String value)
```
    The subnet ID for this `DevEndpoint` .
  - getWorkerType
```
public java.lang.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.
  - setWorkerType
```
public void setWorkerType(java.lang.String value)
```
    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.

Class CfnDevEndpoint

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDevEndpoint

CfnDevEndpoint

CfnDevEndpoint

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getArguments

setArguments

getRoleArn

setRoleArn

getEndpointName

setEndpointName

getExtraJarsS3Path

setExtraJarsS3Path

getExtraPythonLibsS3Path

setExtraPythonLibsS3Path

getGlueVersion

setGlueVersion

getNumberOfNodes

setNumberOfNodes

getNumberOfWorkers

setNumberOfWorkers

getPublicKey

setPublicKey

getPublicKeys

setPublicKeys

getSecurityConfiguration

setSecurityConfiguration

getSecurityGroupIds

setSecurityGroupIds

getSubnetId

setSubnetId

getWorkerType

setWorkerType