software.amazon.awssdk.services.glue.model

Interface Connection.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Connection.Builder,Connection>, SdkBuilder<Connection.Builder,Connection>, SdkPojo

Enclosing class:

Connection

public static interface Connection.Builder
extends SdkPojo, CopyableBuilder<Connection.Builder,Connection>

Method Summary

Modifier and Type	Method and Description
Connection.Builder	connectionProperties(Map<ConnectionPropertyKey,String> connectionProperties) These key-value pairs define parameters for the connection:
Connection.Builder	connectionPropertiesWithStrings(Map<String,String> connectionProperties) These key-value pairs define parameters for the connection:
Connection.Builder	connectionType(ConnectionType connectionType) The type of the connection.
Connection.Builder	connectionType(String connectionType) The type of the connection.
Connection.Builder	creationTime(Instant creationTime) The time this connection definition was created.
Connection.Builder	description(String description) Description of the connection.
Connection.Builder	lastUpdatedBy(String lastUpdatedBy) The user, group or role that last updated this connection definition.
Connection.Builder	lastUpdatedTime(Instant lastUpdatedTime) The last time this connection definition was updated.
Connection.Builder	matchCriteria(Collection<String> matchCriteria) A list of criteria that can be used in selecting this connection.
Connection.Builder	matchCriteria(String... matchCriteria) A list of criteria that can be used in selecting this connection.
Connection.Builder	name(String name) The name of the connection definition.
default Connection.Builder	physicalConnectionRequirements(Consumer<PhysicalConnectionRequirements.Builder> physicalConnectionRequirements) A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.
Connection.Builder	physicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements) A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

name

Connection.Builder name(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.

description

Connection.Builder description(String description)

Description of the connection.

Parameters:

description - Description of the connection.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectionType

Connection.Builder connectionType(String connectionType)

The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

Parameters:

connectionType - The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectionType, ConnectionType

connectionType

Connection.Builder connectionType(ConnectionType connectionType)

The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

Parameters:

connectionType - The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectionType, ConnectionType

matchCriteria

Connection.Builder matchCriteria(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.

matchCriteria

Connection.Builder matchCriteria(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.

connectionPropertiesWithStrings

Connection.Builder connectionPropertiesWithStrings(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.

• 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.

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.

• 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectionProperties

Connection.Builder connectionProperties(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.

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.

• 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

physicalConnectionRequirements

Connection.Builder physicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)

A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.

Parameters:

physicalConnectionRequirements - A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.

Returns:

Returns a reference to this object so that method calls can be chained together.

physicalConnectionRequirements

default Connection.Builder physicalConnectionRequirements(Consumer<PhysicalConnectionRequirements.Builder> physicalConnectionRequirements)

A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.

This is a convenience that creates an instance of the PhysicalConnectionRequirements.Builder avoiding the need to create one manually via PhysicalConnectionRequirements.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to physicalConnectionRequirements(PhysicalConnectionRequirements).

Parameters:

physicalConnectionRequirements - a consumer that will call methods on PhysicalConnectionRequirements.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

physicalConnectionRequirements(PhysicalConnectionRequirements)

creationTime

Connection.Builder creationTime(Instant creationTime)

The time this connection definition was created.

Parameters:

creationTime - The time this connection definition was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastUpdatedTime

Connection.Builder lastUpdatedTime(Instant lastUpdatedTime)

The last time this connection definition was updated.

Parameters:

lastUpdatedTime - The last time this connection definition was updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastUpdatedBy

Connection.Builder lastUpdatedBy(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.