Package software.amazon.awscdk.services.glue

Class CfnDevEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.392Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDevEndpoint

      protected CfnDevEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDevEndpoint

      protected CfnDevEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDevEndpoint

      @Stability(Stable) public CfnDevEndpoint(@NotNull Construct scope, @NotNull String id, @NotNull 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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags to use with this DevEndpoint.

    • getArguments

      @Stability(Stable) @NotNull public 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

      @Stability(Stable) public void setArguments(@NotNull 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

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .

    • getEndpointName

      @Stability(Stable) @Nullable public String getEndpointName()
      The name of the DevEndpoint .

    • setEndpointName

      @Stability(Stable) public void setEndpointName(@Nullable String value)
      The name of the DevEndpoint .

    • getExtraJarsS3Path

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setExtraJarsS3Path(@Nullable 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

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setExtraPythonLibsS3Path(@Nullable 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

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setGlueVersion(@Nullable 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

      @Stability(Stable) @Nullable public Number getNumberOfNodes()
      The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint .

    • setNumberOfNodes

      @Stability(Stable) public void setNumberOfNodes(@Nullable Number value)
      The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint .

    • getNumberOfWorkers

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setNumberOfWorkers(@Nullable 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

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setPublicKey(@Nullable 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

      @Stability(Stable) @Nullable public 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.

    • setPublicKeys

      @Stability(Stable) public void setPublicKeys(@Nullable List<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

      @Stability(Stable) @Nullable public String getSecurityConfiguration()
      The name of the SecurityConfiguration structure to be used with this DevEndpoint .

    • setSecurityConfiguration

      @Stability(Stable) public void setSecurityConfiguration(@Nullable String value)
      The name of the SecurityConfiguration structure to be used with this DevEndpoint .

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      A list of security group identifiers used in this DevEndpoint .

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      A list of security group identifiers used in this DevEndpoint .

    • getSubnetId

      @Stability(Stable) @Nullable public String getSubnetId()
      The subnet ID for this DevEndpoint .

    • setSubnetId

      @Stability(Stable) public void setSubnetId(@Nullable String value)
      The subnet ID for this DevEndpoint .

    • getWorkerType

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setWorkerType(@Nullable 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.