DatabaseSourceDescription ¶

class DatabaseSourceDescription(TypedDict, closed=True):
    type: NotRequired["capo_firehose.types.database_type.DatabaseType"]
    """<p>The type of database engine. This can be one of the following values. </p> <ul> <li> <p>MySQL</p> </li> <li> <p>PostgreSQL</p> </li> </ul> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    endpoint: NotRequired["capo_firehose.types.database_endpoint.DatabaseEndpoint"]
    """<p> The endpoint of the database server. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    port: NotRequired["capo_firehose.types.database_port.DatabasePort"]
    """<p>The port of the database. This can be one of the following values.</p> <ul> <li> <p>3306 for MySQL database type</p> </li> <li> <p>5432 for PostgreSQL database type</p> </li> </ul> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    ssl_mode: NotRequired["capo_firehose.types.ssl_mode.SSLMode"]
    """<p> The mode to enable or disable SSL when Firehose connects to the database endpoint. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    databases: NotRequired["capo_firehose.types.database_list.DatabaseList"]
    """<p> The list of database patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    tables: NotRequired["capo_firehose.types.database_table_list.DatabaseTableList"]
    """<p> The list of table patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    columns: NotRequired["capo_firehose.types.database_column_list.DatabaseColumnList"]
    """<p> The list of column patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    surrogate_keys: NotRequired[
        "capo_firehose.types.database_column_include_or_exclude_list.DatabaseColumnIncludeOrExcludeList"
    ]
    """<p> 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. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    snapshot_watermark_table: NotRequired[
        "capo_firehose.types.database_table_name.DatabaseTableName"
    ]
    """<p> The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    snapshot_info: NotRequired[
        "capo_firehose.types.database_snapshot_info_list.DatabaseSnapshotInfoList"
    ]
    """<p> The structure that describes the snapshot information of a table in source database endpoint that Firehose reads. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    database_source_authentication_configuration: NotRequired[
        "capo_firehose.types.database_source_authentication_configuration.DatabaseSourceAuthenticationConfiguration"
    ]
    """<p> The structure to configure the authentication methods for Firehose to connect to source database endpoint. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""
    database_source_vpc_configuration: NotRequired[
        "capo_firehose.types.database_source_vpc_configuration.DatabaseSourceVPCConfiguration"
    ]
    """<p> The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>"""