ReferenceDataSourceProperty Struct
For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisanalyticsv2 as kinesisanalyticsv2 } from 'aws-cdk-lib';
const referenceDataSourceProperty: kinesisanalyticsv2.CfnApplicationReferenceDataSource.ReferenceDataSourceProperty = {
referenceSchema: {
recordColumns: [{
name: 'name',
sqlType: 'sqlType',
// the properties below are optional
mapping: 'mapping',
}],
recordFormat: {
recordFormatType: 'recordFormatType',
// the properties below are optional
mappingParameters: {
csvMappingParameters: {
recordColumnDelimiter: 'recordColumnDelimiter',
recordRowDelimiter: 'recordRowDelimiter',
},
jsonMappingParameters: {
recordRowPath: 'recordRowPath',
},
},
},
// the properties below are optional
recordEncoding: 'recordEncoding',
},
// the properties below are optional
s3ReferenceDataSource: {
bucketArn: 'bucketArn',
fileKey: 'fileKey',
},
tableName: 'tableName',
};
Properties
referenceSchemaIResolvable | CfnApplicationReferenceDataSource.ReferenceSchemaPropertyreference_schematyping.Union[IResolvable, ReferenceSchemaProperty]referenceSchemaIResolvableReferenceSchemaIResolvableReferenceSchemainterface{}required#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.
s3ReferenceDataSourceoptionalIResolvable | CfnApplicationReferenceDataSource.S3ReferenceDataSourcePropertys3_reference_data_sourceoptionaltyping.Union[IResolvable, S3ReferenceDataSourceProperty]s3ReferenceDataSourceoptionalIResolvableS3ReferenceDataSourceoptionalIResolvableS3ReferenceDataSourceoptionalinterface{}#Identifies the S3 bucket and object that contains the reference data.
notes
A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
tableNameoptionalstringtable_nameoptionalstrtableNameoptionalStringTableNameoptionalstringTableNameoptional*string#The name of the in-application table to create.