java.lang.Object
- software.amazon.awssdk.services.firehose.model.DatabaseSourceConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DatabaseSourceConfiguration.Builder,DatabaseSourceConfiguration>
```
@Generated("software.amazon.awssdk:codegen")
public final class DatabaseSourceConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DatabaseSourceConfiguration.Builder,DatabaseSourceConfiguration>
```
The top level object for configuring streams with database as a source.

Amazon Data Firehose is in preview release and is subject to change.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DatabaseSourceConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DatabaseSourceConfiguration.Builder`	`builder()`
`DatabaseColumnList`	`columns()`	The list of column patterns in source database endpoint for Firehose to read from.
`DatabaseList`	`databases()`	The list of database patterns in source database endpoint for Firehose to read from.
`DatabaseSourceAuthenticationConfiguration`	`databaseSourceAuthenticationConfiguration()`	The structure to configure the authentication methods for Firehose to connect to source database endpoint.
`DatabaseSourceVPCConfiguration`	`databaseSourceVPCConfiguration()`	The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
`String`	`endpoint()`	The endpoint of the database server.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSurrogateKeys()`	For responses, this returns true if the service returned a value for the SurrogateKeys property.
`Integer`	`port()`	The port of the database.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DatabaseSourceConfiguration.Builder>`	`serializableBuilderClass()`
`String`	`snapshotWatermarkTable()`	The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.
`SSLMode`	`sslMode()`	The mode to enable or disable SSL when Firehose connects to the database endpoint.
`String`	`sslModeAsString()`	The mode to enable or disable SSL when Firehose connects to the database endpoint.
`List<String>`	`surrogateKeys()`	The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.
`DatabaseTableList`	`tables()`	The list of table patterns in source database endpoint for Firehose to read from.
`DatabaseSourceConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`DatabaseType`	`type()`	The type of database engine.
`String`	`typeAsString()`	The type of database engine.

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
  - type
```
public final DatabaseType type()
```
    The type of database engine. This can be one of the following values.
    
    MySQL
    
    PostgreSQL
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DatabaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    Returns:
    
    The type of database engine. This can be one of the following values.
    
    MySQL
    
    PostgreSQL
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    See Also:
    
    DatabaseType
  - typeAsString
```
public final String typeAsString()
```
    The type of database engine. This can be one of the following values.
    
    MySQL
    
    PostgreSQL
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DatabaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    Returns:
    
    The type of database engine. This can be one of the following values.
    
    MySQL
    
    PostgreSQL
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    See Also:
    
    DatabaseType
  - endpoint
```
public final String endpoint()
```
    The endpoint of the database server.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    Returns:
    
    The endpoint of the database server.
    
    Amazon Data Firehose is in preview release and is subject to change.
  - port
```
public final Integer port()
```
    The port of the database. This can be one of the following values.
    
    3306 for MySQL database type
    
    5432 for PostgreSQL database type
    
    Amazon Data Firehose is in preview release and is subject to change.
    Returns:
    
    The port of the database. This can be one of the following values.
    
    3306 for MySQL database type
    
    5432 for PostgreSQL database type
    
    Amazon Data Firehose is in preview release and is subject to change.
  - sslMode
```
public final SSLMode sslMode()
```
    The mode to enable or disable SSL when Firehose connects to the database endpoint.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    If the service returns an enum value that is not available in the current SDK version, sslMode will return SSLMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().
    
    Returns:
    
    The mode to enable or disable SSL when Firehose connects to the database endpoint.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    See Also:
    
    SSLMode
  - sslModeAsString
```
public final String sslModeAsString()
```
    The mode to enable or disable SSL when Firehose connects to the database endpoint.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    If the service returns an enum value that is not available in the current SDK version, sslMode will return SSLMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().
    
    Returns:
    
    The mode to enable or disable SSL when Firehose connects to the database endpoint.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    See Also:
    
    SSLMode
  - databases
```
public final DatabaseList databases()
```
    The list of database patterns in source database endpoint for Firehose to read from.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    Returns:
    
    The list of database patterns in source database endpoint for Firehose to read from.
    
    Amazon Data Firehose is in preview release and is subject to change.
  - tables
```
public final DatabaseTableList tables()
```
    The list of table patterns in source database endpoint for Firehose to read from.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    Returns:
    
    The list of table patterns in source database endpoint for Firehose to read from.
    
    Amazon Data Firehose is in preview release and is subject to change.
  - columns
```
public final DatabaseColumnList columns()
```
    The list of column patterns in source database endpoint for Firehose to read from.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    Returns:
    
    The list of column patterns in source database endpoint for Firehose to read from.
    
    Amazon Data Firehose is in preview release and is subject to change.
  - hasSurrogateKeys
```
public final boolean hasSurrogateKeys()
```
    For responses, this returns true if the service returned a value for the SurrogateKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - surrogateKeys
```
public final List<String> surrogateKeys()
```
    The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSurrogateKeys() method.
    
    Returns:
    
    The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.
    
    Amazon Data Firehose is in preview release and is subject to change.
  - snapshotWatermarkTable
```
public final String snapshotWatermarkTable()
```
    The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    Returns:
    
    The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.
    
    Amazon Data Firehose is in preview release and is subject to change.
  - databaseSourceAuthenticationConfiguration
```
public final DatabaseSourceAuthenticationConfiguration databaseSourceAuthenticationConfiguration()
```
    The structure to configure the authentication methods for Firehose to connect to source database endpoint.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    Returns:
    
    The structure to configure the authentication methods for Firehose to connect to source database endpoint.
    
    Amazon Data Firehose is in preview release and is subject to change.
  - databaseSourceVPCConfiguration
```
public final DatabaseSourceVPCConfiguration databaseSourceVPCConfiguration()
```
    The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
    
    Amazon Data Firehose is in preview release and is subject to change.
    
    Returns:
    
    The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
    
    Amazon Data Firehose is in preview release and is subject to change.
  - toBuilder
```
public DatabaseSourceConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DatabaseSourceConfiguration.Builder,DatabaseSourceConfiguration>
  - builder
```
public static DatabaseSourceConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DatabaseSourceConfiguration.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DatabaseSourceConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

type

typeAsString

endpoint

port

sslMode

sslModeAsString

databases

tables

columns

hasSurrogateKeys

surrogateKeys

snapshotWatermarkTable

databaseSourceAuthenticationConfiguration

databaseSourceVPCConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField