DatabaseSourceDescription
The top level object for database source description.
Amazon Data Firehose is in preview release and is subject to change.
Contents
- 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.
Type: DatabaseColumnList object
Required: No
- 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.
Type: DatabaseList object
Required: No
- 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.
Type: DatabaseSourceAuthenticationConfiguration object
Required: No
- 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.
Type: DatabaseSourceVPCConfiguration object
Required: No
- Endpoint
-
The endpoint of the database server.
Amazon Data Firehose is in preview release and is subject to change.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^(?!\s*$).+Required: No
- 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.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 65535.
Required: No
-
- 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.
Type: Array of DatabaseSnapshotInfo objects
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 129.
Pattern:
[\u0001-\uFFFF]*Required: No
- 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.
Type: String
Valid Values:
Disabled | EnabledRequired: No
- 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.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 194.
Pattern:
[\u0001-\uFFFF]*Required: No
- 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.
Type: DatabaseTableList object
Required: No
- 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.
Type: String
Valid Values:
MySQL | PostgreSQLRequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
