Package software.amazon.awssdk.services.firehose.model

Interface DatabaseSourceDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DatabaseSourceDescription.Builder,DatabaseSourceDescription>, SdkBuilder<DatabaseSourceDescription.Builder,DatabaseSourceDescription>, SdkPojo

Enclosing class:

DatabaseSourceDescription

public static interface DatabaseSourceDescription.Builder
extends SdkPojo, CopyableBuilder<DatabaseSourceDescription.Builder,DatabaseSourceDescription>

Method Summary

Modifier and Type	Method	Description
default DatabaseSourceDescription.Builder	columns(Consumer<DatabaseColumnList.Builder> columns)	The list of column patterns in source database endpoint for Firehose to read from.
DatabaseSourceDescription.Builder	columns(DatabaseColumnList columns)	The list of column patterns in source database endpoint for Firehose to read from.
default DatabaseSourceDescription.Builder	databases(Consumer<DatabaseList.Builder> databases)	The list of database patterns in source database endpoint for Firehose to read from.
DatabaseSourceDescription.Builder	databases(DatabaseList databases)	The list of database patterns in source database endpoint for Firehose to read from.
default DatabaseSourceDescription.Builder	databaseSourceAuthenticationConfiguration(Consumer<DatabaseSourceAuthenticationConfiguration.Builder> databaseSourceAuthenticationConfiguration)	The structure to configure the authentication methods for Firehose to connect to source database endpoint.
DatabaseSourceDescription.Builder	databaseSourceAuthenticationConfiguration(DatabaseSourceAuthenticationConfiguration databaseSourceAuthenticationConfiguration)	The structure to configure the authentication methods for Firehose to connect to source database endpoint.
default DatabaseSourceDescription.Builder	databaseSourceVPCConfiguration(Consumer<DatabaseSourceVPCConfiguration.Builder> databaseSourceVPCConfiguration)	The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
DatabaseSourceDescription.Builder	databaseSourceVPCConfiguration(DatabaseSourceVPCConfiguration databaseSourceVPCConfiguration)	The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
DatabaseSourceDescription.Builder	endpoint(String endpoint)	The endpoint of the database server.
DatabaseSourceDescription.Builder	port(Integer port)	The port of the database.
DatabaseSourceDescription.Builder	snapshotInfo(Collection<DatabaseSnapshotInfo> snapshotInfo)	The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.
DatabaseSourceDescription.Builder	snapshotInfo(Consumer<DatabaseSnapshotInfo.Builder>... snapshotInfo)	The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.
DatabaseSourceDescription.Builder	snapshotInfo(DatabaseSnapshotInfo... snapshotInfo)	The structure that describes the snapshot information of a table in source database endpoint that Firehose reads.
DatabaseSourceDescription.Builder	snapshotWatermarkTable(String snapshotWatermarkTable)	The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.
DatabaseSourceDescription.Builder	sslMode(String sslMode)	The mode to enable or disable SSL when Firehose connects to the database endpoint.
DatabaseSourceDescription.Builder	sslMode(SSLMode sslMode)	The mode to enable or disable SSL when Firehose connects to the database endpoint.
DatabaseSourceDescription.Builder	surrogateKeys(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.
DatabaseSourceDescription.Builder	surrogateKeys(Collection<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.
default DatabaseSourceDescription.Builder	tables(Consumer<DatabaseTableList.Builder> tables)	The list of table patterns in source database endpoint for Firehose to read from.
DatabaseSourceDescription.Builder	tables(DatabaseTableList tables)	The list of table patterns in source database endpoint for Firehose to read from.
DatabaseSourceDescription.Builder	type(String type)	The type of database engine.
DatabaseSourceDescription.Builder	type(DatabaseType type)	The type of database engine.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

type

DatabaseSourceDescription.Builder type(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DatabaseType, DatabaseType

type

DatabaseSourceDescription.Builder type(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DatabaseType, DatabaseType

endpoint

DatabaseSourceDescription.Builder endpoint(String endpoint)

The endpoint of the database server.

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

Parameters:

endpoint - The endpoint of the database server.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

port

DatabaseSourceDescription.Builder port(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sslMode

DatabaseSourceDescription.Builder sslMode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SSLMode, SSLMode

sslMode

DatabaseSourceDescription.Builder sslMode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SSLMode, SSLMode

databases

DatabaseSourceDescription.Builder databases(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

databases

default DatabaseSourceDescription.Builder databases(Consumer<DatabaseList.Builder> 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.

This is a convenience method that creates an instance of the DatabaseList.Builder avoiding the need to create one manually via DatabaseList.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to databases(DatabaseList).

Parameters:

databases - a consumer that will call methods on DatabaseList.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

databases(DatabaseList)

tables

DatabaseSourceDescription.Builder tables(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

tables

default DatabaseSourceDescription.Builder tables(Consumer<DatabaseTableList.Builder> 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.

This is a convenience method that creates an instance of the DatabaseTableList.Builder avoiding the need to create one manually via DatabaseTableList.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tables(DatabaseTableList).

Parameters:

tables - a consumer that will call methods on DatabaseTableList.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

tables(DatabaseTableList)

columns

DatabaseSourceDescription.Builder columns(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

columns

default DatabaseSourceDescription.Builder columns(Consumer<DatabaseColumnList.Builder> 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.

This is a convenience method that creates an instance of the DatabaseColumnList.Builder avoiding the need to create one manually via DatabaseColumnList.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to columns(DatabaseColumnList).

Parameters:

columns - a consumer that will call methods on DatabaseColumnList.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

columns(DatabaseColumnList)

surrogateKeys

DatabaseSourceDescription.Builder surrogateKeys(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

surrogateKeys

DatabaseSourceDescription.Builder surrogateKeys(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotWatermarkTable

DatabaseSourceDescription.Builder snapshotWatermarkTable(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

snapshotInfo

DatabaseSourceDescription.Builder snapshotInfo(Collection<DatabaseSnapshotInfo> snapshotInfo)

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

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotInfo

DatabaseSourceDescription.Builder snapshotInfo(DatabaseSnapshotInfo... snapshotInfo)

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

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotInfo

DatabaseSourceDescription.Builder snapshotInfo(Consumer<DatabaseSnapshotInfo.Builder>... snapshotInfo)

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

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

This is a convenience method that creates an instance of the DatabaseSnapshotInfo.Builder avoiding the need to create one manually via DatabaseSnapshotInfo.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #snapshotInfo(List).

Parameters:

snapshotInfo - a consumer that will call methods on DatabaseSnapshotInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#snapshotInfo(java.util.Collection)

databaseSourceAuthenticationConfiguration

DatabaseSourceDescription.Builder databaseSourceAuthenticationConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

databaseSourceAuthenticationConfiguration

default DatabaseSourceDescription.Builder databaseSourceAuthenticationConfiguration(Consumer<DatabaseSourceAuthenticationConfiguration.Builder> 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.

This is a convenience method that creates an instance of the DatabaseSourceAuthenticationConfiguration.Builder avoiding the need to create one manually via DatabaseSourceAuthenticationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to databaseSourceAuthenticationConfiguration(DatabaseSourceAuthenticationConfiguration).

Parameters:

databaseSourceAuthenticationConfiguration - a consumer that will call methods on DatabaseSourceAuthenticationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

databaseSourceAuthenticationConfiguration(DatabaseSourceAuthenticationConfiguration)

databaseSourceVPCConfiguration

DatabaseSourceDescription.Builder databaseSourceVPCConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

databaseSourceVPCConfiguration

default DatabaseSourceDescription.Builder databaseSourceVPCConfiguration(Consumer<DatabaseSourceVPCConfiguration.Builder> 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.

This is a convenience method that creates an instance of the DatabaseSourceVPCConfiguration.Builder avoiding the need to create one manually via DatabaseSourceVPCConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to databaseSourceVPCConfiguration(DatabaseSourceVPCConfiguration).

Parameters:

databaseSourceVPCConfiguration - a consumer that will call methods on DatabaseSourceVPCConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

databaseSourceVPCConfiguration(DatabaseSourceVPCConfiguration)