Skip to content

ReferenceDataSourceDescription

Source code in docs_src/capo_kinesis_analytics_v2/types/reference_data_source_description.py
class ReferenceDataSourceDescription(TypedDict, closed=True):
    reference_id: "capo_kinesis_analytics_v2.types.id.Id"
    """<p>The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the <a>CreateApplication</a> or <a>UpdateApplication</a> operation.</p>"""
    table_name: "capo_kinesis_analytics_v2.types.in_app_table_name.InAppTableName"
    """<p>The in-application table name created by the specific reference data source configuration.</p>"""
    s3_reference_data_source_description: "capo_kinesis_analytics_v2.types.s3_reference_data_source_description.S3ReferenceDataSourceDescription"
    """<p>Provides the Amazon S3 bucket name, the object key name that contains the reference data. </p>"""
    reference_schema: NotRequired[
        "capo_kinesis_analytics_v2.types.source_schema.SourceSchema"
    ]
    """<p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.</p>"""

reference_id instance-attribute

reference_id: Id

The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

reference_schema instance-attribute

reference_schema: NotRequired[SourceSchema]

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

s3_reference_data_source_description instance-attribute

s3_reference_data_source_description: S3ReferenceDataSourceDescription

Provides the Amazon S3 bucket name, the object key name that contains the reference data.

table_name instance-attribute

table_name: InAppTableName

The in-application table name created by the specific reference data source configuration.