interface ReferenceSchemaProperty

Language	Type name
.NET	Amazon.CDK.AWS.KinesisAnalytics.CfnApplicationReferenceDataSource.ReferenceSchemaProperty
Java	software.amazon.awscdk.services.kinesisanalytics.CfnApplicationReferenceDataSource.ReferenceSchemaProperty
Python	aws_cdk.aws_kinesisanalytics.CfnApplicationReferenceDataSource.ReferenceSchemaProperty
TypeScript	@aws-cdk/aws-kinesisanalytics » CfnApplicationReferenceDataSource » ReferenceSchemaProperty

The ReferenceSchema property type specifies the format of the data in the reference source for a SQL-based Amazon Kinesis Data Analytics application.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kinesisanalytics from '@aws-cdk/aws-kinesisanalytics';
const referenceSchemaProperty: kinesisanalytics.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

Name	Type	Description
recordColumns	IResolvable | IResolvable | RecordColumnProperty[]	A list of RecordColumn objects.
recordFormat	IResolvable | RecordFormatProperty	Specifies the format of the records on the reference source.
recordEncoding?	string	Specifies the encoding of the records in the reference source.

---

recordColumns

Type: IResolvable | IResolvable | RecordColumnProperty[]

A list of RecordColumn objects.

---

recordFormat

Type: IResolvable | RecordFormatProperty

Specifies the format of the records on the reference source.

---

recordEncoding?

Type: string (optional)

Specifies the encoding of the records in the reference source.

For example, UTF-8.