Connection (AWS Java SDK :: Services :: AWS Glue 2.15.32 API)

java.lang.Object
- software.amazon.awssdk.services.glue.model.Connection

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Connection.Builder,Connection>

@Generated(value="software.amazon.awssdk:codegen")
public final class Connection
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Connection.Builder,Connection>

Defines a connection to a data source.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Connection.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Connection.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Connection.Builder`	`builder()`
`Map<ConnectionPropertyKey,String>`	`connectionProperties()` These key-value pairs define parameters for the connection:
`Map<String,String>`	`connectionPropertiesAsStrings()` These key-value pairs define parameters for the connection:
`ConnectionType`	`connectionType()` The type of the connection.
`String`	`connectionTypeAsString()` The type of the connection.
`Instant`	`creationTime()` The time that this connection definition was created.
`String`	`description()` The description of the connection.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasConnectionProperties()` Returns true if the ConnectionProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasMatchCriteria()` Returns true if the MatchCriteria property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`lastUpdatedBy()` The user, group, or role that last updated this connection definition.
`Instant`	`lastUpdatedTime()` The last time that this connection definition was updated.
`List<String>`	`matchCriteria()` A list of criteria that can be used in selecting this connection.
`String`	`name()` The name of the connection definition.
`PhysicalConnectionRequirements`	`physicalConnectionRequirements()` A map of physical connection requirements, such as virtual private cloud (VPC) and `SecurityGroup`, that are needed to make this connection successfully.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Connection.Builder>`	`serializableBuilderClass()`
`Connection.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public String name()
```
    The name of the connection definition.
    
    Returns:
    
    The name of the connection definition.
  - description
```
public String description()
```
    The description of the connection.
    
    Returns:
    
    The description of the connection.
  - connectionType
```
public ConnectionType connectionType()
```
    The type of the connection. Currently, SFTP is not supported.
    
    If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().
    
    Returns:
    
    The type of the connection. Currently, SFTP is not supported.
    
    See Also:
    
    ConnectionType
  - connectionTypeAsString
```
public String connectionTypeAsString()
```
    The type of the connection. Currently, SFTP is not supported.
    
    If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().
    
    Returns:
    
    The type of the connection. Currently, SFTP is not supported.
    
    See Also:
    
    ConnectionType
  - hasMatchCriteria
```
public boolean hasMatchCriteria()
```
    Returns true if the MatchCriteria property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - matchCriteria
```
public List<String> matchCriteria()
```
    A list of criteria that can be used in selecting this connection.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasMatchCriteria() to see if a value was sent in this field.
    
    Returns:
    
    A list of criteria that can be used in selecting this connection.
  - connectionProperties
```
public Map<ConnectionPropertyKey,String> 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. 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".
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasConnectionProperties() to see if a value was sent in this field.
    Returns:
    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".
  - hasConnectionProperties
```
public boolean hasConnectionProperties()
```
    Returns true if the ConnectionProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - connectionPropertiesAsStrings
```
public Map<String,String> connectionPropertiesAsStrings()
```
    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".
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasConnectionProperties() to see if a value was sent in this field.
    Returns:
    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".
  - physicalConnectionRequirements
```
public PhysicalConnectionRequirements physicalConnectionRequirements()
```
    A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.
    
    Returns:
    
    A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.
  - creationTime
```
public Instant creationTime()
```
    The time that this connection definition was created.
    
    Returns:
    
    The time that this connection definition was created.
  - lastUpdatedTime
```
public Instant lastUpdatedTime()
```
    The last time that this connection definition was updated.
    
    Returns:
    
    The last time that this connection definition was updated.
  - lastUpdatedBy
```
public String lastUpdatedBy()
```
    The user, group, or role that last updated this connection definition.
    
    Returns:
    
    The user, group, or role that last updated this connection definition.
  - toBuilder
```
public Connection.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Connection.Builder,Connection>
  - builder
```
public static Connection.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Connection.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Connection

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

description

connectionType

connectionTypeAsString

hasMatchCriteria

matchCriteria

connectionProperties

hasConnectionProperties

connectionPropertiesAsStrings

physicalConnectionRequirements

creationTime

lastUpdatedTime

lastUpdatedBy

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields