@Generated(value="software.amazon.awssdk:codegen") public final class Connection extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Connection.Builder,Connection>
Defines a connection to a data source.
Modifier and Type | Class and Description |
---|---|
static interface |
Connection.Builder |
Modifier and Type | Method and Description |
---|---|
static Connection.Builder |
builder() |
Map<ConnectionPropertyKey,String> |
connectionProperties()
These key-value pairs define parameters for the connection:
|
Map<String,String> |
connectionPropertiesAsStrings()
These key-value pairs define parameters for the connection:
|
ConnectionType |
connectionType()
The type of the connection.
|
String |
connectionTypeAsString()
The type of the connection.
|
Instant |
creationTime()
The time this connection definition was created.
|
String |
description()
Description of the connection.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
lastUpdatedBy()
The user, group or role that last updated this connection definition.
|
Instant |
lastUpdatedTime()
The last time this connection definition was updated.
|
List<String> |
matchCriteria()
A list of criteria that can be used in selecting this connection.
|
String |
name()
The name of the connection definition.
|
PhysicalConnectionRequirements |
physicalConnectionRequirements()
A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection
successfully.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Connection.Builder> |
serializableBuilderClass() |
Connection.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String name()
The name of the connection definition.
public String description()
Description of the connection.
public ConnectionType connectionType()
The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
If the service returns an enum value that is not available in the current SDK version, connectionType
will return ConnectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from connectionTypeAsString()
.
ConnectionType
public String connectionTypeAsString()
The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
If the service returns an enum value that is not available in the current SDK version, connectionType
will return ConnectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from connectionTypeAsString()
.
ConnectionType
public List<String> matchCriteria()
A list of criteria that can be used in selecting this connection.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Map<ConnectionPropertyKey,String> connectionProperties()
These key-value pairs define parameters for the connection:
HOST
- The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the
database host.
PORT
- The port number, between 1024 and 65535, of the port on which the database host is listening
for database connections.
USER_NAME
- The name under which to log in to the database. The value string for
USER_NAME
is "USERNAME
".
PASSWORD
- A password, if one is used, for the user name.
JDBC_DRIVER_JAR_URI
- The S3 path of the a 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 SSL with hostname matching will
be enforced for the JDBC connection on the client. The default is false.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
JDBC_DRIVER_JAR_URI
- The S3 path of the a 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 SSL with hostname
matching will be enforced for the JDBC connection on the client. The default is false.
public Map<String,String> connectionPropertiesAsStrings()
These key-value pairs define parameters for the connection:
HOST
- The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the
database host.
PORT
- The port number, between 1024 and 65535, of the port on which the database host is listening
for database connections.
USER_NAME
- The name under which to log in to the database. The value string for
USER_NAME
is "USERNAME
".
PASSWORD
- A password, if one is used, for the user name.
JDBC_DRIVER_JAR_URI
- The S3 path of the a 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 SSL with hostname matching will
be enforced for the JDBC connection on the client. The default is false.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
JDBC_DRIVER_JAR_URI
- The S3 path of the a 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 SSL with hostname
matching will be enforced for the JDBC connection on the client. The default is false.
public PhysicalConnectionRequirements physicalConnectionRequirements()
A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.
public Instant creationTime()
The time this connection definition was created.
public Instant lastUpdatedTime()
The last time this connection definition was updated.
public String lastUpdatedBy()
The user, group or role that last updated this connection definition.
public Connection.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Connection.Builder,Connection>
public static Connection.Builder builder()
public static Class<? extends Connection.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.