@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.
Constructor and Description |
---|
Connection() |
Modifier and Type | Method and Description |
---|---|
Connection |
addConnectionPropertiesEntry(String key,
String value) |
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. |
public void setName(String name)
The name of the connection definition.
name
- The name of the connection definition.public String getName()
The name of the connection definition.
public Connection withName(String name)
The name of the connection definition.
name
- The name of the connection definition.public void setDescription(String description)
The description of the connection.
description
- The description of the connection.public String getDescription()
The description of the connection.
public Connection withDescription(String description)
The description of the connection.
description
- The description of the connection.public void setConnectionType(String connectionType)
The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
connectionType
- The type of the connection. Currently, only JDBC is supported; SFTP is not supported.ConnectionType
public String getConnectionType()
The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
ConnectionType
public Connection withConnectionType(String connectionType)
The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
connectionType
- The type of the connection. Currently, only JDBC is supported; SFTP is not supported.ConnectionType
public Connection withConnectionType(ConnectionType connectionType)
The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
connectionType
- The type of the connection. Currently, only JDBC is supported; SFTP is not supported.ConnectionType
public List<String> getMatchCriteria()
A list of criteria that can be used in selecting this connection.
public void setMatchCriteria(Collection<String> matchCriteria)
A list of criteria that can be used in selecting this connection.
matchCriteria
- A list of criteria that can be used in selecting this connection.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.
matchCriteria
- A list of criteria that can be used in selecting this connection.public Connection withMatchCriteria(Collection<String> matchCriteria)
A list of criteria that can be used in selecting this connection.
matchCriteria
- A list of criteria that can be used in selecting this connection.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 the JDBC connection.
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
.
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 the JDBC connection.
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
.
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 the JDBC connection.
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
.
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 the JDBC connection.
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
.
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 the JDBC connection.
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
.
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 the JDBC connection.
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
.
public Connection addConnectionPropertiesEntry(String key, String value)
public Connection clearConnectionPropertiesEntries()
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.
physicalConnectionRequirements
- A map of physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup
, that are needed to make this connection successfully.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.
SecurityGroup
, that are needed to make this connection successfully.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.
physicalConnectionRequirements
- A map of physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup
, that are needed to make this connection successfully.public void setCreationTime(Date creationTime)
The time that this connection definition was created.
creationTime
- The time that this connection definition was created.public Date getCreationTime()
The time that this connection definition was created.
public Connection withCreationTime(Date creationTime)
The time that this connection definition was created.
creationTime
- The time that this connection definition was created.public void setLastUpdatedTime(Date lastUpdatedTime)
The last time that this connection definition was updated.
lastUpdatedTime
- The last time that this connection definition was updated.public Date getLastUpdatedTime()
The last time that this connection definition was updated.
public Connection withLastUpdatedTime(Date lastUpdatedTime)
The last time that this connection definition was updated.
lastUpdatedTime
- The last time that this connection definition was updated.public void setLastUpdatedBy(String lastUpdatedBy)
The user, group, or role that last updated this connection definition.
lastUpdatedBy
- The user, group, or role that last updated this connection definition.public String getLastUpdatedBy()
The user, group, or role that last updated this connection definition.
public Connection withLastUpdatedBy(String lastUpdatedBy)
The user, group, or role that last updated this connection definition.
lastUpdatedBy
- The user, group, or role that last updated this connection definition.public String toString()
toString
in class Object
Object.toString()
public Connection clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2019. All rights reserved.