Connection (AWS Java SDK for AWS Glue 1.12.237 API)

java.lang.Object
- com.amazonaws.services.glue.model.Connection

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Connection
extends Object
implements Serializable, Cloneable, StructuredPojo

Defines a connection to a data source.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Connection()

Constructors
Constructor and Description
`Connection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Connection`	`addConnectionPropertiesEntry(String key, String value)` Add a single ConnectionProperties entry
`Connection`	`clearConnectionPropertiesEntries()` Removes all the entries added into ConnectionProperties.
`Connection`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getConnectionProperties()` These key-value pairs define parameters for the connection:
`String`	`getConnectionType()` The type of the connection.
`Date`	`getCreationTime()` The time that this connection definition was created.
`String`	`getDescription()` The description of the connection.
`String`	`getLastUpdatedBy()` The user, group, or role that last updated this connection definition.
`Date`	`getLastUpdatedTime()` The last time that this connection definition was updated.
`List<String>`	`getMatchCriteria()` A list of criteria that can be used in selecting this connection.
`String`	`getName()` The name of the connection definition.
`PhysicalConnectionRequirements`	`getPhysicalConnectionRequirements()` A map of physical connection requirements, such as virtual private cloud (VPC) and `SecurityGroup`, that are needed to make this connection successfully.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setConnectionProperties(Map<String,String> connectionProperties)` These key-value pairs define parameters for the connection:
`void`	`setConnectionType(String connectionType)` The type of the connection.
`void`	`setCreationTime(Date creationTime)` The time that this connection definition was created.
`void`	`setDescription(String description)` The description of the connection.
`void`	`setLastUpdatedBy(String lastUpdatedBy)` The user, group, or role that last updated this connection definition.
`void`	`setLastUpdatedTime(Date lastUpdatedTime)` The last time that this connection definition was updated.
`void`	`setMatchCriteria(Collection<String> matchCriteria)` A list of criteria that can be used in selecting this connection.
`void`	`setName(String name)` The name of the connection definition.
`void`	`setPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)` A map of physical connection requirements, such as virtual private cloud (VPC) and `SecurityGroup`, that are needed to make this connection successfully.
`String`	`toString()` Returns a string representation of this object.
`Connection`	`withConnectionProperties(Map<String,String> connectionProperties)` These key-value pairs define parameters for the connection:
`Connection`	`withConnectionType(ConnectionType connectionType)` The type of the connection.
`Connection`	`withConnectionType(String connectionType)` The type of the connection.
`Connection`	`withCreationTime(Date creationTime)` The time that this connection definition was created.
`Connection`	`withDescription(String description)` The description of the connection.
`Connection`	`withLastUpdatedBy(String lastUpdatedBy)` The user, group, or role that last updated this connection definition.
`Connection`	`withLastUpdatedTime(Date lastUpdatedTime)` The last time that this connection definition was updated.
`Connection`	`withMatchCriteria(Collection<String> matchCriteria)` A list of criteria that can be used in selecting this connection.
`Connection`	`withMatchCriteria(String... matchCriteria)` A list of criteria that can be used in selecting this connection.
`Connection`	`withName(String name)` The name of the connection definition.
`Connection`	`withPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)` A map of physical connection requirements, such as virtual private cloud (VPC) and `SecurityGroup`, that are needed to make this connection successfully.

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

- Constructor Detail
  - Connection
```
public Connection()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the connection definition.
    
    Parameters:
    
    name - The name of the connection definition.
  - getName
```
public String getName()
```
    The name of the connection definition.
    
    Returns:
    
    The name of the connection definition.
  - withName
```
public Connection withName(String name)
```
    The name of the connection definition.
    
    Parameters:
    
    name - The name of the connection definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the connection.
    
    Parameters:
    
    description - The description of the connection.
  - getDescription
```
public String getDescription()
```
    The description of the connection.
    
    Returns:
    
    The description of the connection.
  - withDescription
```
public Connection withDescription(String description)
```
    The description of the connection.
    
    Parameters:
    
    description - The description of the connection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectionType
```
public void setConnectionType(String connectionType)
```
    The type of the connection. Currently, SFTP is not supported.
    
    Parameters:
    
    connectionType - The type of the connection. Currently, SFTP is not supported.
    
    See Also:
    
    ConnectionType
  - getConnectionType
```
public String getConnectionType()
```
    The type of the connection. Currently, SFTP is not supported.
    
    Returns:
    
    The type of the connection. Currently, SFTP is not supported.
    
    See Also:
    
    ConnectionType
  - withConnectionType
```
public Connection withConnectionType(String connectionType)
```
    The type of the connection. Currently, SFTP is not supported.
    
    Parameters:
    
    connectionType - The type of the connection. Currently, SFTP is not supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectionType
  - withConnectionType
```
public Connection withConnectionType(ConnectionType connectionType)
```
    The type of the connection. Currently, SFTP is not supported.
    
    Parameters:
    
    connectionType - The type of the connection. Currently, SFTP is not supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectionType
  - getMatchCriteria
```
public List<String> getMatchCriteria()
```
    A list of criteria that can be used in selecting this connection.
    
    Returns:
    
    A list of criteria that can be used in selecting this connection.
  - setMatchCriteria
```
public void setMatchCriteria(Collection<String> matchCriteria)
```
    A list of criteria that can be used in selecting this connection.
    
    Parameters:
    
    matchCriteria - A list of criteria that can be used in selecting this connection.
  - withMatchCriteria
```
public Connection withMatchCriteria(String... matchCriteria)
```
    A list of criteria that can be used in selecting this connection.
    
    NOTE: This method appends the values to the existing list (if any). Use setMatchCriteria(java.util.Collection) or withMatchCriteria(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    matchCriteria - A list of criteria that can be used in selecting this connection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMatchCriteria
```
public Connection withMatchCriteria(Collection<String> matchCriteria)
```
    A list of criteria that can be used in selecting this connection.
    
    Parameters:
    
    matchCriteria - A list of criteria that can be used in selecting this connection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getConnectionProperties
```
public Map<String,String> getConnectionProperties()
```
    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. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. 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. 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 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. 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 Glue encrypt passwords setting selected).
    - ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
    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. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. 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. 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 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. 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 Glue encrypt passwords setting selected).
    
    ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
  - setConnectionProperties
```
public void setConnectionProperties(Map<String,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. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. 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. 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 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. 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 Glue encrypt passwords setting selected).
    - ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
    Parameters:
    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. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. 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. 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 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. 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 Glue encrypt passwords setting selected).
    
    ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
  - withConnectionProperties
```
public Connection withConnectionProperties(Map<String,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. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. 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. 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 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. 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 Glue encrypt passwords setting selected).
    - ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
    Parameters:
    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. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. 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. 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 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. 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 Glue encrypt passwords setting selected).
    
    ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addConnectionPropertiesEntry
```
public Connection addConnectionPropertiesEntry(String key,
                                               String value)
```
    Add a single ConnectionProperties entry
    
    See Also:
    
    withConnectionProperties(java.util.Map<java.lang.String, java.lang.String>)
  - clearConnectionPropertiesEntries
```
public Connection clearConnectionPropertiesEntries()
```
    Removes all the entries added into ConnectionProperties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPhysicalConnectionRequirements
```
public void setPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)
```
    A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.
    
    Parameters:
    
    physicalConnectionRequirements - A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.
  - getPhysicalConnectionRequirements
```
public PhysicalConnectionRequirements getPhysicalConnectionRequirements()
```
    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.
  - withPhysicalConnectionRequirements
```
public Connection withPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)
```
    A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.
    
    Parameters:
    
    physicalConnectionRequirements - A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time that this connection definition was created.
    
    Parameters:
    
    creationTime - The time that this connection definition was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time that this connection definition was created.
    
    Returns:
    
    The time that this connection definition was created.
  - withCreationTime
```
public Connection withCreationTime(Date creationTime)
```
    The time that this connection definition was created.
    
    Parameters:
    
    creationTime - The time that this connection definition was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedTime
```
public void setLastUpdatedTime(Date lastUpdatedTime)
```
    The last time that this connection definition was updated.
    
    Parameters:
    
    lastUpdatedTime - The last time that this connection definition was updated.
  - getLastUpdatedTime
```
public Date getLastUpdatedTime()
```
    The last time that this connection definition was updated.
    
    Returns:
    
    The last time that this connection definition was updated.
  - withLastUpdatedTime
```
public Connection withLastUpdatedTime(Date lastUpdatedTime)
```
    The last time that this connection definition was updated.
    
    Parameters:
    
    lastUpdatedTime - The last time that this connection definition was updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedBy
```
public void setLastUpdatedBy(String lastUpdatedBy)
```
    The user, group, or role that last updated this connection definition.
    
    Parameters:
    
    lastUpdatedBy - The user, group, or role that last updated this connection definition.
  - getLastUpdatedBy
```
public String getLastUpdatedBy()
```
    The user, group, or role that last updated this connection definition.
    
    Returns:
    
    The user, group, or role that last updated this connection definition.
  - withLastUpdatedBy
```
public Connection withLastUpdatedBy(String lastUpdatedBy)
```
    The user, group, or role that last updated this connection definition.
    
    Parameters:
    
    lastUpdatedBy - The user, group, or role that last updated this connection definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Connection clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Connection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Connection

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setConnectionType

getConnectionType

withConnectionType

withConnectionType

getMatchCriteria

setMatchCriteria

withMatchCriteria

withMatchCriteria

getConnectionProperties

setConnectionProperties

withConnectionProperties

addConnectionPropertiesEntry

clearConnectionPropertiesEntries

setPhysicalConnectionRequirements

getPhysicalConnectionRequirements

withPhysicalConnectionRequirements

setCreationTime

getCreationTime

withCreationTime

setLastUpdatedTime

getLastUpdatedTime

withLastUpdatedTime

setLastUpdatedBy

getLastUpdatedBy

withLastUpdatedBy

toString

equals

hashCode

clone

marshall