Menu
AWS Glue
Web API Reference (API Version 2017-03-31)

Connection

Defines a connection to a data source.

Contents

ConnectionProperties

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.

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

  • ENCRYPTED_PASSWORD - (Reserved for future use).

  • JDBC_DRIVER_JAR_URI - The S3 path of the a 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 the JDBC connection.

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

Type: String to string map

Valid Keys: HOST | PORT | USERNAME | PASSWORD | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL

Value Length Constraints: Maximum length of 1024.

Required: No

ConnectionType

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

Type: String

Valid Values: JDBC | SFTP

Required: No

CreationTime

The time this connection definition was created.

Type: Timestamp

Required: No

Description

Description of the connection.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

LastUpdatedBy

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

LastUpdatedTime

The last time this connection definition was updated.

Type: Timestamp

Required: No

MatchCriteria

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

Name

The name of the connection definition.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

PhysicalConnectionRequirements

A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.

Type: PhysicalConnectionRequirements object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: