@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)
Add a single ConnectionProperties entry
|
Connection |
clearConnectionPropertiesEntries()
Removes all the entries added into ConnectionProperties.
|
Connection |
clone() |
boolean |
equals(Object obj) |
AuthenticationConfiguration |
getAuthenticationConfiguration()
The authentication properties of the connection.
|
Map<String,String> |
getConnectionProperties()
These key-value pairs define parameters for the connection:
|
String |
getConnectionType()
The type of the connection.
|
Date |
getCreationTime()
The timestamp of the time that this connection definition was created.
|
String |
getDescription()
The description of the connection.
|
Date |
getLastConnectionValidationTime()
A timestamp of the time this connection was last validated.
|
String |
getLastUpdatedBy()
The user, group, or role that last updated this connection definition.
|
Date |
getLastUpdatedTime()
The timestamp of the last time the 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()
The physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup , that
are needed to make this connection successfully. |
String |
getStatus()
The status of the connection.
|
String |
getStatusReason()
The reason for the connection status.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAuthenticationConfiguration(AuthenticationConfiguration authenticationConfiguration)
The authentication properties of the connection.
|
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 timestamp of the time that this connection definition was created.
|
void |
setDescription(String description)
The description of the connection.
|
void |
setLastConnectionValidationTime(Date lastConnectionValidationTime)
A timestamp of the time this connection was last validated.
|
void |
setLastUpdatedBy(String lastUpdatedBy)
The user, group, or role that last updated this connection definition.
|
void |
setLastUpdatedTime(Date lastUpdatedTime)
The timestamp of the last time the 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)
The physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup , that
are needed to make this connection successfully. |
void |
setStatus(String status)
The status of the connection.
|
void |
setStatusReason(String statusReason)
The reason for the connection status.
|
String |
toString()
Returns a string representation of this object.
|
Connection |
withAuthenticationConfiguration(AuthenticationConfiguration authenticationConfiguration)
The authentication properties of the connection.
|
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 timestamp of the time that this connection definition was created.
|
Connection |
withDescription(String description)
The description of the connection.
|
Connection |
withLastConnectionValidationTime(Date lastConnectionValidationTime)
A timestamp of the time this connection was last validated.
|
Connection |
withLastUpdatedBy(String lastUpdatedBy)
The user, group, or role that last updated this connection definition.
|
Connection |
withLastUpdatedTime(Date lastUpdatedTime)
The timestamp of the last time the 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)
The physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup , that
are needed to make this connection successfully. |
Connection |
withStatus(ConnectionStatus status)
The status of the connection.
|
Connection |
withStatus(String status)
The status of the connection.
|
Connection |
withStatusReason(String statusReason)
The reason for the connection status.
|
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, SFTP is not supported.
connectionType
- The type of the connection. Currently, SFTP is not supported.ConnectionType
public String getConnectionType()
The type of the connection. Currently, SFTP is not supported.
ConnectionType
public Connection withConnectionType(String connectionType)
The type of the connection. Currently, SFTP is not supported.
connectionType
- The type of the connection. Currently, SFTP is not supported.ConnectionType
public Connection withConnectionType(ConnectionType connectionType)
The type of the connection. Currently, SFTP is not supported.
connectionType
- The type of the connection. Currently, 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 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.
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_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".
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).
KAFKA_SASL_MECHANISM
- "SCRAM-SHA-512"
, "GSSAPI"
,
"AWS_MSK_IAM"
, or "PLAIN"
. These are the supported SASL Mechanisms.
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN" mechanism.
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN" mechanism.
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the
user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the "SCRAM-SHA-512"
mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the "SCRAM-SHA-512"
mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the
user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets
Manager.
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores
long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf
stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation:
krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with
sasl.kerberos.service.name
in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information,
see Kafka Documentation:
Configuring Kafka Brokers.
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.
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_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".
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).
KAFKA_SASL_MECHANISM
- "SCRAM-SHA-512"
, "GSSAPI"
,
"AWS_MSK_IAM"
, or "PLAIN"
. These are the supported SASL Mechanisms.
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN"
mechanism.
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN"
mechanism.
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password
(if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the
"SCRAM-SHA-512" mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the
"SCRAM-SHA-512" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password
(if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services
Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab
stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation:
Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A
krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more
information, see MIT
Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with
sasl.kerberos.service.name
in your Kafka
Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more
information, see Kafka Documentation:
Configuring Kafka Brokers.
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.
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_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".
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).
KAFKA_SASL_MECHANISM
- "SCRAM-SHA-512"
, "GSSAPI"
,
"AWS_MSK_IAM"
, or "PLAIN"
. These are the supported SASL Mechanisms.
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN" mechanism.
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN" mechanism.
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the
user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the "SCRAM-SHA-512"
mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the "SCRAM-SHA-512"
mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the
user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets
Manager.
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores
long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf
stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation:
krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with
sasl.kerberos.service.name
in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information,
see Kafka Documentation:
Configuring Kafka Brokers.
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.
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_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".
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).
KAFKA_SASL_MECHANISM
- "SCRAM-SHA-512"
, "GSSAPI"
,
"AWS_MSK_IAM"
, or "PLAIN"
. These are the supported SASL Mechanisms.
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN"
mechanism.
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN"
mechanism.
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password
(if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the
"SCRAM-SHA-512" mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the
"SCRAM-SHA-512" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password
(if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services
Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab
stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation:
Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A
krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more
information, see MIT
Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with
sasl.kerberos.service.name
in your Kafka
Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more
information, see Kafka Documentation:
Configuring Kafka Brokers.
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.
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_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".
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).
KAFKA_SASL_MECHANISM
- "SCRAM-SHA-512"
, "GSSAPI"
,
"AWS_MSK_IAM"
, or "PLAIN"
. These are the supported SASL Mechanisms.
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN" mechanism.
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN" mechanism.
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the
user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the "SCRAM-SHA-512"
mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the "SCRAM-SHA-512"
mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the
user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets
Manager.
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab stores
long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A krb5.conf
stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation:
krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with
sasl.kerberos.service.name
in your Kafka Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information,
see Kafka Documentation:
Configuring Kafka Brokers.
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.
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_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".
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).
KAFKA_SASL_MECHANISM
- "SCRAM-SHA-512"
, "GSSAPI"
,
"AWS_MSK_IAM"
, or "PLAIN"
. These are the supported SASL Mechanisms.
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN"
mechanism.
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN"
mechanism.
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password
(if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the
"SCRAM-SHA-512" mechanism.
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the
"SCRAM-SHA-512" mechanism.
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password
(if the user has the Glue encrypt passwords setting selected).
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services
Secrets Manager.
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberos keytab
file. A keytab
stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation:
Keytab.
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberos krb5.conf
file. A
krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more
information, see MIT
Kerberos Documentation: krb5.conf.
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set with
sasl.kerberos.service.name
in your Kafka
Configuration.
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more
information, see Kafka Documentation:
Configuring Kafka Brokers.
public Connection addConnectionPropertiesEntry(String key, String value)
public Connection clearConnectionPropertiesEntries()
public void setPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)
The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that
are needed to make this connection successfully.
physicalConnectionRequirements
- The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
,
that are needed to make this connection successfully.public PhysicalConnectionRequirements getPhysicalConnectionRequirements()
The 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)
The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that
are needed to make this connection successfully.
physicalConnectionRequirements
- The 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 timestamp of the time that this connection definition was created.
creationTime
- The timestamp of the time that this connection definition was created.public Date getCreationTime()
The timestamp of the time that this connection definition was created.
public Connection withCreationTime(Date creationTime)
The timestamp of the time that this connection definition was created.
creationTime
- The timestamp of the time that this connection definition was created.public void setLastUpdatedTime(Date lastUpdatedTime)
The timestamp of the last time the connection definition was updated.
lastUpdatedTime
- The timestamp of the last time the connection definition was updated.public Date getLastUpdatedTime()
The timestamp of the last time the connection definition was updated.
public Connection withLastUpdatedTime(Date lastUpdatedTime)
The timestamp of the last time the connection definition was updated.
lastUpdatedTime
- The timestamp of the last time the 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 void setStatus(String status)
The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
status
- The status of the connection. Can be one of: READY
, IN_PROGRESS
, or
FAILED
.ConnectionStatus
public String getStatus()
The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
READY
, IN_PROGRESS
, or
FAILED
.ConnectionStatus
public Connection withStatus(String status)
The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
status
- The status of the connection. Can be one of: READY
, IN_PROGRESS
, or
FAILED
.ConnectionStatus
public Connection withStatus(ConnectionStatus status)
The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
status
- The status of the connection. Can be one of: READY
, IN_PROGRESS
, or
FAILED
.ConnectionStatus
public void setStatusReason(String statusReason)
The reason for the connection status.
statusReason
- The reason for the connection status.public String getStatusReason()
The reason for the connection status.
public Connection withStatusReason(String statusReason)
The reason for the connection status.
statusReason
- The reason for the connection status.public void setLastConnectionValidationTime(Date lastConnectionValidationTime)
A timestamp of the time this connection was last validated.
lastConnectionValidationTime
- A timestamp of the time this connection was last validated.public Date getLastConnectionValidationTime()
A timestamp of the time this connection was last validated.
public Connection withLastConnectionValidationTime(Date lastConnectionValidationTime)
A timestamp of the time this connection was last validated.
lastConnectionValidationTime
- A timestamp of the time this connection was last validated.public void setAuthenticationConfiguration(AuthenticationConfiguration authenticationConfiguration)
The authentication properties of the connection.
authenticationConfiguration
- The authentication properties of the connection.public AuthenticationConfiguration getAuthenticationConfiguration()
The authentication properties of the connection.
public Connection withAuthenticationConfiguration(AuthenticationConfiguration authenticationConfiguration)
The authentication properties of the connection.
authenticationConfiguration
- The authentication properties of the connection.public String toString()
toString
in class Object
Object.toString()
public Connection clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.