Amazon Kinesis Analytics
kinesisanalytics (API Version 2018-05-23)

ReferenceDataSourceDescription

For an SQL-based Amazon Kinesis Data Analytics application, describes the reference data source configured for an application.

Contents

ReferenceId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

ReferenceSchema

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.

Type: SourceSchema object

Required: No

S3ReferenceDataSourceDescription

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

Type: S3ReferenceDataSourceDescription object

Required: Yes

TableName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: