ConnectionConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.ConnectionConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConnectionConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides the configuration information that's required to connect to a database.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConnectionConfiguration()

Constructors
Constructor and Description
`ConnectionConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConnectionConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDatabaseHost()` The name of the host for the database.
`String`	`getDatabaseName()` The name of the database containing the document data.
`Integer`	`getDatabasePort()` The port that the database uses for connections.
`String`	`getSecretArn()` The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.
`String`	`getTableName()` The name of the table that contains the document data.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDatabaseHost(String databaseHost)` The name of the host for the database.
`void`	`setDatabaseName(String databaseName)` The name of the database containing the document data.
`void`	`setDatabasePort(Integer databasePort)` The port that the database uses for connections.
`void`	`setSecretArn(String secretArn)` The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.
`void`	`setTableName(String tableName)` The name of the table that contains the document data.
`String`	`toString()` Returns a string representation of this object.
`ConnectionConfiguration`	`withDatabaseHost(String databaseHost)` The name of the host for the database.
`ConnectionConfiguration`	`withDatabaseName(String databaseName)` The name of the database containing the document data.
`ConnectionConfiguration`	`withDatabasePort(Integer databasePort)` The port that the database uses for connections.
`ConnectionConfiguration`	`withSecretArn(String secretArn)` The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.
`ConnectionConfiguration`	`withTableName(String tableName)` The name of the table that contains the document data.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConnectionConfiguration
```
public ConnectionConfiguration()
```
- Method Detail
  - setDatabaseHost
```
public void setDatabaseHost(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.
    
    Parameters:
    
    databaseHost - The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
  - getDatabaseHost
```
public String getDatabaseHost()
```
    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.
  - withDatabaseHost
```
public ConnectionConfiguration withDatabaseHost(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatabasePort
```
public void setDatabasePort(Integer databasePort)
```
    The port that the database uses for connections.
    
    Parameters:
    
    databasePort - The port that the database uses for connections.
  - getDatabasePort
```
public Integer getDatabasePort()
```
    The port that the database uses for connections.
    
    Returns:
    
    The port that the database uses for connections.
  - withDatabasePort
```
public ConnectionConfiguration withDatabasePort(Integer databasePort)
```
    The port that the database uses for connections.
    
    Parameters:
    
    databasePort - The port that the database uses for connections.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    The name of the database containing the document data.
    
    Parameters:
    
    databaseName - The name of the database containing the document data.
  - getDatabaseName
```
public String getDatabaseName()
```
    The name of the database containing the document data.
    
    Returns:
    
    The name of the database containing the document data.
  - withDatabaseName
```
public ConnectionConfiguration withDatabaseName(String databaseName)
```
    The name of the database containing the document data.
    
    Parameters:
    
    databaseName - The name of the database containing the document data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTableName
```
public void setTableName(String tableName)
```
    The name of the table that contains the document data.
    
    Parameters:
    
    tableName - The name of the table that contains the document data.
  - getTableName
```
public String getTableName()
```
    The name of the table that contains the document data.
    
    Returns:
    
    The name of the table that contains the document data.
  - withTableName
```
public ConnectionConfiguration withTableName(String tableName)
```
    The name of the table that contains the document data.
    
    Parameters:
    
    tableName - The name of the table that contains the document data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretArn
```
public void setSecretArn(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.
    
    Parameters:
    
    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.
  - getSecretArn
```
public String getSecretArn()
```
    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.
  - withSecretArn
```
public ConnectionConfiguration withSecretArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ConnectionConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class ConnectionConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectionConfiguration

Method Detail

setDatabaseHost

getDatabaseHost

withDatabaseHost

setDatabasePort

getDatabasePort

withDatabasePort

setDatabaseName

getDatabaseName

withDatabaseName

setTableName

getTableName

withTableName

setSecretArn

getSecretArn

withSecretArn

toString

equals

hashCode

clone

marshall