firehose/aws.sdk.kotlin.services.firehose.model/DatabaseSourceDescription

DatabaseSourceDescription

class DatabaseSourceDescription

The top level object for database source description.

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

Types

Builder

class Builder

Companion

object Companion

Properties

columns

val columns: DatabaseColumnList?

The list of column patterns in source database endpoint for Firehose to read from.

databases

val databases: DatabaseList?

The list of database patterns in source database endpoint for Firehose to read from.

databaseSourceAuthenticationConfiguration

val databaseSourceAuthenticationConfiguration: DatabaseSourceAuthenticationConfiguration?

The structure to configure the authentication methods for Firehose to connect to source database endpoint.

databaseSourceVpcConfiguration

val databaseSourceVpcConfiguration: DatabaseSourceVpcConfiguration?

The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.

endpoint

val endpoint: String?

The endpoint of the database server.

port

val port: Int?

The port of the database. This can be one of the following values.

snapshotInfo

val snapshotInfo: List<DatabaseSnapshotInfo>?

The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.

snapshotWatermarkTable

val snapshotWatermarkTable: String?

The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.

sslMode

val sslMode: SslMode?

The mode to enable or disable SSL when Firehose connects to the database endpoint.

surrogateKeys

val surrogateKeys: List<String>?

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.

tables

val tables: DatabaseTableList?

The list of table patterns in source database endpoint for Firehose to read from.

type

val type: DatabaseType?

The type of database engine. This can be one of the following values.

Functions

copy

inline fun copy(block: DatabaseSourceDescription.Builder.() -> Unit = {}): DatabaseSourceDescription

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String