Skip to content

ReferenceDataSourceDescription

Source code in docs_src/capo_kinesis_analytics/types/reference_data_source_description.py 
16
17
18
19
20
21
22
23
24
25
26
class ReferenceDataSourceDescription(TypedDict, closed=True):
    reference_id: "capo_kinesis_analytics.types.id.Id"
    """<p>ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html">AddApplicationReferenceDataSource</a> operation.</p>"""
    table_name: "capo_kinesis_analytics.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.types.s3_reference_data_source_description.S3ReferenceDataSourceDescription"
    """<p>Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.</p>"""
    reference_schema: NotRequired[
        "capo_kinesis_analytics.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

ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource 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 S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.

table_name instance-attribute 

table_name: InAppTableName

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