interface ReferenceDataSourceProperty

Language	Type name
.NET	`Amazon.CDK.AWS.KinesisAnalyticsV2.CfnApplicationReferenceDataSource.ReferenceDataSourceProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesisanalyticsv2#CfnApplicationReferenceDataSource_ReferenceDataSourceProperty`
Java	`software.amazon.awscdk.services.kinesisanalyticsv2.CfnApplicationReferenceDataSource.ReferenceDataSourceProperty`
Python	`aws_cdk.aws_kinesisanalyticsv2.CfnApplicationReferenceDataSource.ReferenceDataSourceProperty`
TypeScript	`aws-cdk-lib` » `aws_kinesisanalyticsv2` » `CfnApplicationReferenceDataSource` » `ReferenceDataSourceProperty`

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

// 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

Name	Type	Description
referenceSchema	`IResolvable` `\|` `ReferenceSchemaProperty`	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.
s3ReferenceDataSource?	`IResolvable` `\|` `S3ReferenceDataSourceProperty`	Identifies the S3 bucket and object that contains the reference data.
tableName?	`string`	The name of the in-application table to create.

referenceSchema

Type: IResolvable | ReferenceSchemaProperty

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.

s3ReferenceDataSource?

Type: IResolvable | S3ReferenceDataSourceProperty (optional)

Identifies the S3 bucket and object that contains the reference data.

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.

tableName?

Type: string (optional)

The name of the in-application table to create.