aws-cdk-lib.aws_kinesisanalyticsv2.CfnApplicationReferenceDataSource.ReferenceSchemaProperty

interface ReferenceSchemaProperty

LanguageType name
.NETAmazon.CDK.AWS.KinesisAnalyticsV2.CfnApplicationReferenceDataSource.ReferenceSchemaProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskinesisanalyticsv2#CfnApplicationReferenceDataSource_ReferenceSchemaProperty
Javasoftware.amazon.awscdk.services.kinesisanalyticsv2.CfnApplicationReferenceDataSource.ReferenceSchemaProperty
Pythonaws_cdk.aws_kinesisanalyticsv2.CfnApplicationReferenceDataSource.ReferenceSchemaProperty
TypeScript aws-cdk-lib » aws_kinesisanalyticsv2 » CfnApplicationReferenceDataSource » ReferenceSchemaProperty

For a SQL-based Kinesis Data Analytics application, 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.

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 referenceSchemaProperty: kinesisanalyticsv2.CfnApplicationReferenceDataSource.ReferenceSchemaProperty = {
  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',
};

Properties

NameTypeDescription
recordColumnsIResolvable | IResolvable | RecordColumnProperty[]A list of RecordColumn objects.
recordFormatIResolvable | RecordFormatPropertySpecifies the format of the records on the streaming source.
recordEncoding?stringSpecifies the encoding of the records in the streaming source.

recordColumns

Type: IResolvable | IResolvable | RecordColumnProperty[]

A list of RecordColumn objects.


recordFormat

Type: IResolvable | RecordFormatProperty

Specifies the format of the records on the streaming source.


recordEncoding?

Type: string (optional)

Specifies the encoding of the records in the streaming source.

For example, UTF-8.