You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Glue::Types::Connection

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Defines a connection to a data source.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#connection_properties ⇒ Hash<String,String>

These key-value pairs define parameters for the connection:

  • HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.

  • PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.

  • USER_NAME - The name under which to log in to the database. The value string for USER_NAME is \"USERNAME\".

  • PASSWORD - A password, if one is used, for the user name.

  • ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

  • JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.

  • JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

  • JDBC_ENGINE - The name of the JDBC engine to use.

  • JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

  • CONFIG_FILES - (Reserved for future use.)

  • INSTANCE_ID - The instance ID to use.

  • JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.

  • JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.

  • CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer\'s root certificate. AWS Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. AWS Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.

  • SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. AWS Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip AWS Glue’s validation of the customer certificate.

  • CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.

  • CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.

  • KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.

  • KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".

  • KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.

  • KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. AWS Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".

Returns:

  • (Hash<String,String>) —

    These key-value pairs define parameters for the connection:.

#connection_type ⇒ String

The type of the connection. Currently, SFTP is not supported.

Possible values:

  • JDBC
  • SFTP
  • MONGODB
  • KAFKA
  • NETWORK

Returns:

  • (String) —

    The type of the connection.

#creation_time ⇒ Time

The time that this connection definition was created.

Returns:

  • (Time) —

    The time that this connection definition was created.

#description ⇒ String

The description of the connection.

Returns:

  • (String) —

    The description of the connection.

#last_updated_by ⇒ String

The user, group, or role that last updated this connection definition.

Returns:

  • (String) —

    The user, group, or role that last updated this connection definition.

#last_updated_time ⇒ Time

The last time that this connection definition was updated.

Returns:

  • (Time) —

    The last time that this connection definition was updated.

#match_criteria ⇒ Array<String>

A list of criteria that can be used in selecting this connection.

Returns:

  • (Array<String>) —

    A list of criteria that can be used in selecting this connection.

#name ⇒ String

The name of the connection definition.

Returns:

  • (String) —

    The name of the connection definition.

#physical_connection_requirements ⇒ Types::PhysicalConnectionRequirements

A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.

Returns:

  • (Types::PhysicalConnectionRequirements) —

    A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.