Package software.amazon.awssdk.services.kendra.model

Class ConnectionConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.ConnectionConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConnectionConfiguration.Builder,ConnectionConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class ConnectionConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConnectionConfiguration.Builder,ConnectionConfiguration>

Provides the configuration information that's required to connect to a database.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConnectionConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ConnectionConfiguration.Builder	builder()
String	databaseHost()	The name of the host for the database.
String	databaseName()	The name of the database containing the document data.
Integer	databasePort()	The port that the database uses for connections.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
String	secretArn()	The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.
static Class<? extends ConnectionConfiguration.Builder>	serializableBuilderClass()
String	tableName()	The name of the table that contains the document data.
ConnectionConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

databaseHost

public final String databaseHost()

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

Returns:

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

databasePort

public final Integer databasePort()

The port that the database uses for connections.

Returns:

The port that the database uses for connections.

databaseName

public final String databaseName()

The name of the database containing the document data.

Returns:

The name of the database containing the document data.

tableName

public final String tableName()

The name of the table that contains the document data.

Returns:

The name of the table that contains the document data.

secretArn

public final String secretArn()

The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

Returns:

The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

toBuilder

public ConnectionConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConnectionConfiguration.Builder,ConnectionConfiguration>

builder

public static ConnectionConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ConnectionConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo