DatabaseConfiguration (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DatabaseConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides the information necessary to connect a database to an index.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DatabaseConfiguration()

Constructors
Constructor and Description
`DatabaseConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DatabaseConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`AclConfiguration`	`getAclConfiguration()` Information about the database column that provides information for user context filtering.
`ColumnConfiguration`	`getColumnConfiguration()` Information about where the index should get the document information from the database.
`ConnectionConfiguration`	`getConnectionConfiguration()` The information necessary to connect to a database.
`String`	`getDatabaseEngineType()` The type of database engine that runs the database.
`DataSourceVpcConfiguration`	`getVpcConfiguration()`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAclConfiguration(AclConfiguration aclConfiguration)` Information about the database column that provides information for user context filtering.
`void`	`setColumnConfiguration(ColumnConfiguration columnConfiguration)` Information about where the index should get the document information from the database.
`void`	`setConnectionConfiguration(ConnectionConfiguration connectionConfiguration)` The information necessary to connect to a database.
`void`	`setDatabaseEngineType(String databaseEngineType)` The type of database engine that runs the database.
`void`	`setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)`
`String`	`toString()` Returns a string representation of this object.
`DatabaseConfiguration`	`withAclConfiguration(AclConfiguration aclConfiguration)` Information about the database column that provides information for user context filtering.
`DatabaseConfiguration`	`withColumnConfiguration(ColumnConfiguration columnConfiguration)` Information about where the index should get the document information from the database.
`DatabaseConfiguration`	`withConnectionConfiguration(ConnectionConfiguration connectionConfiguration)` The information necessary to connect to a database.
`DatabaseConfiguration`	`withDatabaseEngineType(DatabaseEngineType databaseEngineType)` The type of database engine that runs the database.
`DatabaseConfiguration`	`withDatabaseEngineType(String databaseEngineType)` The type of database engine that runs the database.
`DatabaseConfiguration`	`withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)`

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

- Constructor Detail
  - DatabaseConfiguration
```
public DatabaseConfiguration()
```
- Method Detail
  - setDatabaseEngineType
```
public void setDatabaseEngineType(String databaseEngineType)
```
    The type of database engine that runs the database.
    
    Parameters:
    
    databaseEngineType - The type of database engine that runs the database.
    
    See Also:
    
    DatabaseEngineType
  - getDatabaseEngineType
```
public String getDatabaseEngineType()
```
    The type of database engine that runs the database.
    
    Returns:
    
    The type of database engine that runs the database.
    
    See Also:
    
    DatabaseEngineType
  - withDatabaseEngineType
```
public DatabaseConfiguration withDatabaseEngineType(String databaseEngineType)
```
    The type of database engine that runs the database.
    
    Parameters:
    
    databaseEngineType - The type of database engine that runs the database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DatabaseEngineType
  - withDatabaseEngineType
```
public DatabaseConfiguration withDatabaseEngineType(DatabaseEngineType databaseEngineType)
```
    The type of database engine that runs the database.
    
    Parameters:
    
    databaseEngineType - The type of database engine that runs the database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DatabaseEngineType
  - setConnectionConfiguration
```
public void setConnectionConfiguration(ConnectionConfiguration connectionConfiguration)
```
    The information necessary to connect to a database.
    
    Parameters:
    
    connectionConfiguration - The information necessary to connect to a database.
  - getConnectionConfiguration
```
public ConnectionConfiguration getConnectionConfiguration()
```
    The information necessary to connect to a database.
    
    Returns:
    
    The information necessary to connect to a database.
  - withConnectionConfiguration
```
public DatabaseConfiguration withConnectionConfiguration(ConnectionConfiguration connectionConfiguration)
```
    The information necessary to connect to a database.
    
    Parameters:
    
    connectionConfiguration - The information necessary to connect to a database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfiguration
```
public void setVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
```
    Parameters:
    
    vpcConfiguration -
  - getVpcConfiguration
```
public DataSourceVpcConfiguration getVpcConfiguration()
```
    Returns:
  - withVpcConfiguration
```
public DatabaseConfiguration withVpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
```
    Parameters:
    
    vpcConfiguration -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setColumnConfiguration
```
public void setColumnConfiguration(ColumnConfiguration columnConfiguration)
```
    Information about where the index should get the document information from the database.
    
    Parameters:
    
    columnConfiguration - Information about where the index should get the document information from the database.
  - getColumnConfiguration
```
public ColumnConfiguration getColumnConfiguration()
```
    Information about where the index should get the document information from the database.
    
    Returns:
    
    Information about where the index should get the document information from the database.
  - withColumnConfiguration
```
public DatabaseConfiguration withColumnConfiguration(ColumnConfiguration columnConfiguration)
```
    Information about where the index should get the document information from the database.
    
    Parameters:
    
    columnConfiguration - Information about where the index should get the document information from the database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAclConfiguration
```
public void setAclConfiguration(AclConfiguration aclConfiguration)
```
    Information about the database column that provides information for user context filtering.
    
    Parameters:
    
    aclConfiguration - Information about the database column that provides information for user context filtering.
  - getAclConfiguration
```
public AclConfiguration getAclConfiguration()
```
    Information about the database column that provides information for user context filtering.
    
    Returns:
    
    Information about the database column that provides information for user context filtering.
  - withAclConfiguration
```
public DatabaseConfiguration withAclConfiguration(AclConfiguration aclConfiguration)
```
    Information about the database column that provides information for user context filtering.
    
    Parameters:
    
    aclConfiguration - Information about the database column that provides information for user context filtering.
    
    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 DatabaseConfiguration 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.

Did this page help you?

Class DatabaseConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatabaseConfiguration

Method Detail

setDatabaseEngineType

getDatabaseEngineType

withDatabaseEngineType

withDatabaseEngineType

setConnectionConfiguration

getConnectionConfiguration

withConnectionConfiguration

setVpcConfiguration

getVpcConfiguration

withVpcConfiguration

setColumnConfiguration

getColumnConfiguration

withColumnConfiguration

setAclConfiguration

getAclConfiguration

withAclConfiguration

toString

equals

hashCode

clone

marshall