amazonka-glue-2.0: Amazon Glue SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Glue.Types.DevEndpoint

Description

 
Synopsis

Documentation

data DevEndpoint Source #

A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.

See: newDevEndpoint smart constructor.

Constructors

DevEndpoint' 

Fields

  • arguments :: Maybe (HashMap Text Text)

    A map of arguments used to configure the DevEndpoint.

    Valid arguments are:

    • "--enable-glue-datacatalog": ""

    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.

  • availabilityZone :: Maybe Text

    The Amazon Web Services Availability Zone where this DevEndpoint is located.

  • createdTimestamp :: Maybe POSIX

    The point in time at which this DevEndpoint was created.

  • endpointName :: Maybe Text

    The name of the DevEndpoint.

  • extraJarsS3Path :: Maybe Text

    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 :: Maybe Text

    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.

  • failureReason :: Maybe Text

    The reason for a current failure in this DevEndpoint.

  • glueVersion :: Maybe Text

    Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

    For more information about the available 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.

  • lastModifiedTimestamp :: Maybe POSIX

    The point in time at which this DevEndpoint was last modified.

  • lastUpdateStatus :: Maybe Text

    The status of the last update.

  • numberOfNodes :: Maybe Int

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

  • numberOfWorkers :: Maybe Int

    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.

  • privateAddress :: Maybe Text

    A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.

  • publicAddress :: Maybe Text

    The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint.

  • publicKey :: Maybe Text

    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 :: Maybe [Text]

    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.

  • roleArn :: Maybe Text

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

  • securityConfiguration :: Maybe Text

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

  • securityGroupIds :: Maybe [Text]

    A list of security group identifiers used in this DevEndpoint.

  • status :: Maybe Text

    The current status of this DevEndpoint.

  • subnetId :: Maybe Text

    The subnet ID for this DevEndpoint.

  • vpcId :: Maybe Text

    The ID of the virtual private cloud (VPC) used by this DevEndpoint.

  • workerType :: Maybe WorkerType

    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.

  • yarnEndpointAddress :: Maybe Text

    The YARN endpoint address used by this DevEndpoint.

  • zeppelinRemoteSparkInterpreterPort :: Maybe Int

    The Apache Zeppelin port for the remote Apache Spark interpreter.

Instances

Instances details
FromJSON DevEndpoint Source # 
Instance details

Defined in Amazonka.Glue.Types.DevEndpoint

Generic DevEndpoint Source # 
Instance details

Defined in Amazonka.Glue.Types.DevEndpoint

Associated Types

type Rep DevEndpoint :: Type -> Type #

Read DevEndpoint Source # 
Instance details

Defined in Amazonka.Glue.Types.DevEndpoint

Show DevEndpoint Source # 
Instance details

Defined in Amazonka.Glue.Types.DevEndpoint

NFData DevEndpoint Source # 
Instance details

Defined in Amazonka.Glue.Types.DevEndpoint

Methods

rnf :: DevEndpoint -> () #

Eq DevEndpoint Source # 
Instance details

Defined in Amazonka.Glue.Types.DevEndpoint

Hashable DevEndpoint Source # 
Instance details

Defined in Amazonka.Glue.Types.DevEndpoint

type Rep DevEndpoint Source # 
Instance details

Defined in Amazonka.Glue.Types.DevEndpoint

type Rep DevEndpoint = D1 ('MetaData "DevEndpoint" "Amazonka.Glue.Types.DevEndpoint" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "DevEndpoint'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "extraJarsS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "extraPythonLibsS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "glueVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "lastUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "numberOfNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "numberOfWorkers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "privateAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "publicAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "publicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "publicKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "securityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerType))) :*: (S1 ('MetaSel ('Just "yarnEndpointAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "zeppelinRemoteSparkInterpreterPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))))

newDevEndpoint :: DevEndpoint Source #

Create a value of DevEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arguments:DevEndpoint', devEndpoint_arguments - A map of arguments used to configure the DevEndpoint.

Valid arguments are:

  • "--enable-glue-datacatalog": ""

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.

$sel:availabilityZone:DevEndpoint', devEndpoint_availabilityZone - The Amazon Web Services Availability Zone where this DevEndpoint is located.

$sel:createdTimestamp:DevEndpoint', devEndpoint_createdTimestamp - The point in time at which this DevEndpoint was created.

$sel:endpointName:DevEndpoint', devEndpoint_endpointName - The name of the DevEndpoint.

$sel:extraJarsS3Path:DevEndpoint', devEndpoint_extraJarsS3Path - 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.

$sel:extraPythonLibsS3Path:DevEndpoint', devEndpoint_extraPythonLibsS3Path - 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.

$sel:failureReason:DevEndpoint', devEndpoint_failureReason - The reason for a current failure in this DevEndpoint.

$sel:glueVersion:DevEndpoint', devEndpoint_glueVersion - Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

For more information about the available 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.

$sel:lastModifiedTimestamp:DevEndpoint', devEndpoint_lastModifiedTimestamp - The point in time at which this DevEndpoint was last modified.

$sel:lastUpdateStatus:DevEndpoint', devEndpoint_lastUpdateStatus - The status of the last update.

$sel:numberOfNodes:DevEndpoint', devEndpoint_numberOfNodes - The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

$sel:numberOfWorkers:DevEndpoint', devEndpoint_numberOfWorkers - 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.

$sel:privateAddress:DevEndpoint', devEndpoint_privateAddress - A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.

$sel:publicAddress:DevEndpoint', devEndpoint_publicAddress - The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint.

$sel:publicKey:DevEndpoint', devEndpoint_publicKey - 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.

$sel:publicKeys:DevEndpoint', devEndpoint_publicKeys - 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.

$sel:roleArn:DevEndpoint', devEndpoint_roleArn - The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint.

$sel:securityConfiguration:DevEndpoint', devEndpoint_securityConfiguration - The name of the SecurityConfiguration structure to be used with this DevEndpoint.

$sel:securityGroupIds:DevEndpoint', devEndpoint_securityGroupIds - A list of security group identifiers used in this DevEndpoint.

$sel:status:DevEndpoint', devEndpoint_status - The current status of this DevEndpoint.

$sel:subnetId:DevEndpoint', devEndpoint_subnetId - The subnet ID for this DevEndpoint.

$sel:vpcId:DevEndpoint', devEndpoint_vpcId - The ID of the virtual private cloud (VPC) used by this DevEndpoint.

$sel:workerType:DevEndpoint', devEndpoint_workerType - 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.

$sel:yarnEndpointAddress:DevEndpoint', devEndpoint_yarnEndpointAddress - The YARN endpoint address used by this DevEndpoint.

$sel:zeppelinRemoteSparkInterpreterPort:DevEndpoint', devEndpoint_zeppelinRemoteSparkInterpreterPort - The Apache Zeppelin port for the remote Apache Spark interpreter.

devEndpoint_arguments :: Lens' DevEndpoint (Maybe (HashMap Text Text)) Source #

A map of arguments used to configure the DevEndpoint.

Valid arguments are:

  • "--enable-glue-datacatalog": ""

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.

devEndpoint_availabilityZone :: Lens' DevEndpoint (Maybe Text) Source #

The Amazon Web Services Availability Zone where this DevEndpoint is located.

devEndpoint_createdTimestamp :: Lens' DevEndpoint (Maybe UTCTime) Source #

The point in time at which this DevEndpoint was created.

devEndpoint_endpointName :: Lens' DevEndpoint (Maybe Text) Source #

The name of the DevEndpoint.

devEndpoint_extraJarsS3Path :: Lens' DevEndpoint (Maybe Text) Source #

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.

devEndpoint_extraPythonLibsS3Path :: Lens' DevEndpoint (Maybe Text) Source #

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.

devEndpoint_failureReason :: Lens' DevEndpoint (Maybe Text) Source #

The reason for a current failure in this DevEndpoint.

devEndpoint_glueVersion :: Lens' DevEndpoint (Maybe Text) Source #

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

For more information about the available 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.

devEndpoint_lastModifiedTimestamp :: Lens' DevEndpoint (Maybe UTCTime) Source #

The point in time at which this DevEndpoint was last modified.

devEndpoint_lastUpdateStatus :: Lens' DevEndpoint (Maybe Text) Source #

The status of the last update.

devEndpoint_numberOfNodes :: Lens' DevEndpoint (Maybe Int) Source #

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

devEndpoint_numberOfWorkers :: Lens' DevEndpoint (Maybe Int) Source #

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.

devEndpoint_privateAddress :: Lens' DevEndpoint (Maybe Text) Source #

A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.

devEndpoint_publicAddress :: Lens' DevEndpoint (Maybe Text) Source #

The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint.

devEndpoint_publicKey :: Lens' DevEndpoint (Maybe Text) Source #

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.

devEndpoint_publicKeys :: Lens' DevEndpoint (Maybe [Text]) Source #

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.

devEndpoint_roleArn :: Lens' DevEndpoint (Maybe Text) Source #

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

devEndpoint_securityConfiguration :: Lens' DevEndpoint (Maybe Text) Source #

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

devEndpoint_securityGroupIds :: Lens' DevEndpoint (Maybe [Text]) Source #

A list of security group identifiers used in this DevEndpoint.

devEndpoint_status :: Lens' DevEndpoint (Maybe Text) Source #

The current status of this DevEndpoint.

devEndpoint_subnetId :: Lens' DevEndpoint (Maybe Text) Source #

The subnet ID for this DevEndpoint.

devEndpoint_vpcId :: Lens' DevEndpoint (Maybe Text) Source #

The ID of the virtual private cloud (VPC) used by this DevEndpoint.

devEndpoint_workerType :: Lens' DevEndpoint (Maybe WorkerType) Source #

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.

devEndpoint_yarnEndpointAddress :: Lens' DevEndpoint (Maybe Text) Source #

The YARN endpoint address used by this DevEndpoint.

devEndpoint_zeppelinRemoteSparkInterpreterPort :: Lens' DevEndpoint (Maybe Int) Source #

The Apache Zeppelin port for the remote Apache Spark interpreter.