Interface DatabaseSourceConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DatabaseSourceConfiguration.Builder,DatabaseSourceConfiguration>, SdkBuilder<DatabaseSourceConfiguration.Builder,DatabaseSourceConfiguration>, SdkPojo
Enclosing class:
DatabaseSourceConfiguration
@Mutable @NotThreadSafe public static interface DatabaseSourceConfiguration.Builder extends SdkPojo, CopyableBuilder<DatabaseSourceConfiguration.Builder,DatabaseSourceConfiguration>

  • Method Details

    • type

      DatabaseSourceConfiguration.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:

    • type

      DatabaseSourceConfiguration.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:

    • endpoint

      DatabaseSourceConfiguration.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

      DatabaseSourceConfiguration.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

      DatabaseSourceConfiguration.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

      DatabaseSourceConfiguration.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:

    • databases

      DatabaseSourceConfiguration.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 DatabaseSourceConfiguration.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:

    • tables

      DatabaseSourceConfiguration.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 DatabaseSourceConfiguration.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:

    • columns

      DatabaseSourceConfiguration.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 DatabaseSourceConfiguration.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:

    • surrogateKeys

      DatabaseSourceConfiguration.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

      DatabaseSourceConfiguration.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

      DatabaseSourceConfiguration.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.

    • databaseSourceAuthenticationConfiguration

      DatabaseSourceConfiguration.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 DatabaseSourceConfiguration.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:

    • databaseSourceVPCConfiguration

      DatabaseSourceConfiguration.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 DatabaseSourceConfiguration.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: