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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-glue/types.rb

Overview

Defines a connection to a data source.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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”.

  • ‘SECRET_ID` - The secret ID used for the secret manager of credentials.

  • ‘CONNECTOR_URL` - The connector URL for a MARKETPLACE or CUSTOM connection.

  • ‘CONNECTOR_TYPE` - The connector type for a MARKETPLACE or CUSTOM connection.

  • ‘CONNECTOR_CLASS_NAME` - The connector class name for a MARKETPLACE or CUSTOM connection.

  • ‘KAFKA_CLIENT_KEYSTORE` - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).

  • ‘KAFKA_CLIENT_KEYSTORE_PASSWORD` - The password to access the provided keystore (Optional).

  • ‘KAFKA_CLIENT_KEY_PASSWORD` - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).

  • ‘ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` - The encrypted version of the Kafka client keystore password (if the user has the AWS Glue encrypt passwords setting selected).

  • ‘ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` - The encrypted version of the Kafka client key password (if the user has the AWS Glue encrypt passwords setting selected).

Returns:

  • (Hash<String,String>) 


2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/aws-sdk-glue/types.rb', line 2043

class Connection < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :creation_time,
  :last_updated_time,
  :last_updated_by)
  SENSITIVE = []
  include Aws::Structure
end

#connection_type ⇒ String

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

Returns:

  • (String) 


2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/aws-sdk-glue/types.rb', line 2043

class Connection < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :creation_time,
  :last_updated_time,
  :last_updated_by)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time that this connection definition was created.

Returns:

  • (Time) 


2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/aws-sdk-glue/types.rb', line 2043

class Connection < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :creation_time,
  :last_updated_time,
  :last_updated_by)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the connection.

Returns:

  • (String) 


2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/aws-sdk-glue/types.rb', line 2043

class Connection < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :creation_time,
  :last_updated_time,
  :last_updated_by)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_by ⇒ String

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

Returns:

  • (String) 


2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/aws-sdk-glue/types.rb', line 2043

class Connection < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :creation_time,
  :last_updated_time,
  :last_updated_by)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

The last time that this connection definition was updated.

Returns:

  • (Time) 


2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/aws-sdk-glue/types.rb', line 2043

class Connection < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :creation_time,
  :last_updated_time,
  :last_updated_by)
  SENSITIVE = []
  include Aws::Structure
end

#match_criteria ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/aws-sdk-glue/types.rb', line 2043

class Connection < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :creation_time,
  :last_updated_time,
  :last_updated_by)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the connection definition.

Returns:

  • (String) 


2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/aws-sdk-glue/types.rb', line 2043

class Connection < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :creation_time,
  :last_updated_time,
  :last_updated_by)
  SENSITIVE = []
  include Aws::Structure
end

#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:



2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/aws-sdk-glue/types.rb', line 2043

class Connection < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :creation_time,
  :last_updated_time,
  :last_updated_by)
  SENSITIVE = []
  include Aws::Structure
end