Class: Aws::Firehose::Types::DatabaseSourceDescription

Inherits:

Struct

• Object
• Struct
• Aws::Firehose::Types::DatabaseSourceDescription

Defined in:

gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb

Overview

The top level object for database source description.

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #columns ⇒ Types::DatabaseColumnList

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

• #database_source_authentication_configuration ⇒ Types::DatabaseSourceAuthenticationConfiguration

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

• #database_source_vpc_configuration ⇒ Types::DatabaseSourceVPCConfiguration

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

• #databases ⇒ Types::DatabaseList

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

• #endpoint ⇒ String

  The endpoint of the database server.

• #port ⇒ Integer

  The port of the database.

• #snapshot_info ⇒ Array<Types::DatabaseSnapshotInfo>

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

• #snapshot_watermark_table ⇒ String

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

• #ssl_mode ⇒ String

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

• #surrogate_keys ⇒ Array<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 ⇒ Types::DatabaseTableList

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

• #type ⇒ String

  The type of database engine.

Instance Attribute Details

#columns ⇒ Types::DatabaseColumnList

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:

• (Types::DatabaseColumnList)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#database_source_authentication_configuration ⇒ Types::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:

• (Types::DatabaseSourceAuthenticationConfiguration)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#database_source_vpc_configuration ⇒ Types::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:

• (Types::DatabaseSourceVPCConfiguration)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#databases ⇒ Types::DatabaseList

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:

• (Types::DatabaseList)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

The endpoint of the database server.

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

Returns:

• (String)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

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:

• (Integer)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_info ⇒ Array<Types::DatabaseSnapshotInfo>

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:

• (Array<Types::DatabaseSnapshotInfo>)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_watermark_table ⇒ String

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:

• (String)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ssl_mode ⇒ String

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:

• (String)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#surrogate_keys ⇒ Array<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.

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tables ⇒ Types::DatabaseTableList

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:

• (Types::DatabaseTableList)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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:

• (String)

# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 1300

class DatabaseSourceDescription < Struct.new(
  :type,
  :endpoint,
  :port,
  :ssl_mode,
  :databases,
  :tables,
  :columns,
  :surrogate_keys,
  :snapshot_watermark_table,
  :snapshot_info,
  :database_source_authentication_configuration,
  :database_source_vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end