1.204.0

class CfnDevEndpoint (construct)

LanguageType name
.NETAmazon.CDK.AWS.Glue.CfnDevEndpoint
Javasoftware.amazon.awscdk.services.glue.CfnDevEndpoint
Pythonaws_cdk.aws_glue.CfnDevEndpoint
TypeScript @aws-cdk/aws-glue » CfnDevEndpoint

Implements IConstruct, IConstruct, IDependable, 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 * as glue from '@aws-cdk/aws-glue';

declare const arguments_: any;
declare const tags: any;
const cfnDevEndpoint = new glue.CfnDevEndpoint(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: ['publicKeys'],
  securityConfiguration: 'securityConfiguration',
  securityGroupIds: ['securityGroupIds'],
  subnetId: 'subnetId',
  tags: tags,
  workerType: 'workerType',
});

Initializer

new CfnDevEndpoint(scope: Construct, id: string, props: CfnDevEndpointProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnDevEndpointProps — - resource properties.

Create a new AWS::Glue::DevEndpoint.

Construct Props

NameTypeDescription
roleArnstringThe Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .
arguments?anyA map of arguments used to configure the DevEndpoint .
endpointName?stringThe name of the DevEndpoint .
extraJarsS3Path?stringThe path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint .
extraPythonLibsS3Path?stringThe paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint .
glueVersion?stringThe AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
numberOfNodes?numberThe number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint .
numberOfWorkers?numberThe number of workers of a defined workerType that are allocated to the development endpoint.
publicKey?stringThe public key to be used by this DevEndpoint for authentication.
publicKeys?string[]A list of public keys to be used by the DevEndpoints for authentication.
securityConfiguration?stringThe name of the SecurityConfiguration structure to be used with this DevEndpoint .
securityGroupIds?string[]A list of security group identifiers used in this DevEndpoint .
subnetId?stringThe subnet ID for this DevEndpoint .
tags?anyThe tags to use with this DevEndpoint.
workerType?stringThe type of predefined worker that is allocated to the development endpoint.

roleArn

Type: string

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

arguments?

Type: any (optional)

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.

endpointName?

Type: string (optional)

The name of the DevEndpoint .

extraJarsS3Path?

Type: string (optional)

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 .

extraPythonLibsS3Path?

Type: string (optional)

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.

glueVersion?

Type: string (optional)

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.

numberOfNodes?

Type: number (optional)

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

numberOfWorkers?

Type: number (optional)

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 .

publicKey?

Type: string (optional)

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.

publicKeys?

Type: string[] (optional)

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.

securityConfiguration?

Type: string (optional)

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

securityGroupIds?

Type: string[] (optional)

A list of security group identifiers used in this DevEndpoint .

subnetId?

Type: string (optional)

The subnet ID for this DevEndpoint .

tags?

Type: any (optional)

The tags to use with this DevEndpoint.

workerType?

Type: string (optional)

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.

Properties

NameTypeDescription
argumentsanyA map of arguments used to configure the DevEndpoint .
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeConstructNodeThe construct tree node associated with this construct.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
roleArnstringThe Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint .
stackStackThe stack in which this element is defined.
tagsTagManagerThe tags to use with this DevEndpoint.
endpointName?stringThe name of the DevEndpoint .
extraJarsS3Path?stringThe path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint .
extraPythonLibsS3Path?stringThe paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint .
glueVersion?stringThe AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
numberOfNodes?numberThe number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint .
numberOfWorkers?numberThe number of workers of a defined workerType that are allocated to the development endpoint.
publicKey?stringThe public key to be used by this DevEndpoint for authentication.
publicKeys?string[]A list of public keys to be used by the DevEndpoints for authentication.
securityConfiguration?stringThe name of the SecurityConfiguration structure to be used with this DevEndpoint .
securityGroupIds?string[]A list of security group identifiers used in this DevEndpoint .
subnetId?stringThe subnet ID for this DevEndpoint .
workerType?stringThe type of predefined worker that is allocated to the development endpoint.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

arguments

Type: any

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.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

roleArn

Type: string

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

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Type: TagManager

The tags to use with this DevEndpoint.

endpointName?

Type: string (optional)

The name of the DevEndpoint .

extraJarsS3Path?

Type: string (optional)

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 .

extraPythonLibsS3Path?

Type: string (optional)

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.

glueVersion?

Type: string (optional)

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.

numberOfNodes?

Type: number (optional)

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

numberOfWorkers?

Type: number (optional)

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 .

publicKey?

Type: string (optional)

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.

publicKeys?

Type: string[] (optional)

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.

securityConfiguration?

Type: string (optional)

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

securityGroupIds?

Type: string[] (optional)

A list of security group identifiers used in this DevEndpoint .

subnetId?

Type: string (optional)

The subnet ID for this DevEndpoint .

workerType?

Type: string (optional)

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →