Skip to content
v2.278.0

ReferenceSchemaProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisanalytics as kinesisanalytics } from 'aws-cdk-lib';
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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kinesisanalytics as kinesisanalytics

reference_schema_property = kinesisanalytics.CfnApplicationReferenceDataSource.ReferenceSchemaProperty(
    record_columns=[kinesisanalytics.CfnApplicationReferenceDataSource.RecordColumnProperty(
        name="name",
        sql_type="sqlType",

        # the properties below are optional
        mapping="mapping"
    )],
    record_format=kinesisanalytics.CfnApplicationReferenceDataSource.RecordFormatProperty(
        record_format_type="recordFormatType",

        # the properties below are optional
        mapping_parameters=kinesisanalytics.CfnApplicationReferenceDataSource.MappingParametersProperty(
            csv_mapping_parameters=kinesisanalytics.CfnApplicationReferenceDataSource.CSVMappingParametersProperty(
                record_column_delimiter="recordColumnDelimiter",
                record_row_delimiter="recordRowDelimiter"
            ),
            json_mapping_parameters=kinesisanalytics.CfnApplicationReferenceDataSource.JSONMappingParametersProperty(
                record_row_path="recordRowPath"
            )
        )
    ),

    # the properties below are optional
    record_encoding="recordEncoding"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kinesisanalytics.*;

ReferenceSchemaProperty referenceSchemaProperty = ReferenceSchemaProperty.builder()
        .recordColumns(List.of(RecordColumnProperty.builder()
                .name("name")
                .sqlType("sqlType")

                // the properties below are optional
                .mapping("mapping")
                .build()))
        .recordFormat(RecordFormatProperty.builder()
                .recordFormatType("recordFormatType")

                // the properties below are optional
                .mappingParameters(MappingParametersProperty.builder()
                        .csvMappingParameters(CSVMappingParametersProperty.builder()
                                .recordColumnDelimiter("recordColumnDelimiter")
                                .recordRowDelimiter("recordRowDelimiter")
                                .build())
                        .jsonMappingParameters(JSONMappingParametersProperty.builder()
                                .recordRowPath("recordRowPath")
                                .build())
                        .build())
                .build())

        // the properties below are optional
        .recordEncoding("recordEncoding")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisAnalytics;

var referenceSchemaProperty = new ReferenceSchemaProperty {
    RecordColumns = new [] { new RecordColumnProperty {
        Name = "name",
        SqlType = "sqlType",

        // the properties below are optional
        Mapping = "mapping"
    } },
    RecordFormat = new RecordFormatProperty {
        RecordFormatType = "recordFormatType",

        // the properties below are optional
        MappingParameters = new MappingParametersProperty {
            CsvMappingParameters = new CSVMappingParametersProperty {
                RecordColumnDelimiter = "recordColumnDelimiter",
                RecordRowDelimiter = "recordRowDelimiter"
            },
            JsonMappingParameters = new JSONMappingParametersProperty {
                RecordRowPath = "recordRowPath"
            }
        }
    },

    // the properties below are optional
    RecordEncoding = "recordEncoding"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

referenceSchemaProperty := &ReferenceSchemaProperty{
	RecordColumns: []interface{}{
		&RecordColumnProperty{
			Name: jsii.String("name"),
			SqlType: jsii.String("sqlType"),

			// the properties below are optional
			Mapping: jsii.String("mapping"),
		},
	},
	RecordFormat: &RecordFormatProperty{
		RecordFormatType: jsii.String("recordFormatType"),

		// the properties below are optional
		MappingParameters: &MappingParametersProperty{
			CsvMappingParameters: &CSVMappingParametersProperty{
				RecordColumnDelimiter: jsii.String("recordColumnDelimiter"),
				RecordRowDelimiter: jsii.String("recordRowDelimiter"),
			},
			JsonMappingParameters: &JSONMappingParametersProperty{
				RecordRowPath: jsii.String("recordRowPath"),
			},
		},
	},

	// the properties below are optional
	RecordEncoding: jsii.String("recordEncoding"),
}

Properties ​

recordColumnsIResolvable | IResolvable | CfnApplicationReferenceDataSource.RecordColumnProperty[]record_columnstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RecordColumnProperty]]]recordColumnsIResolvableRecordColumnsIResolvableRecordColumnsinterface{} required #
A list of RecordColumn objects.
recordEncodingoptionalstringrecord_encodingoptionalstrrecordEncodingoptionalStringRecordEncodingoptionalstringRecordEncodingoptional*string #
Specifies the encoding of the records in the reference source.

For example, UTF-8.

recordFormatIResolvable | CfnApplicationReferenceDataSource.RecordFormatPropertyrecord_formattyping.Union[IResolvable, RecordFormatProperty]recordFormatIResolvableRecordFormatIResolvableRecordFormatinterface{} required #
Specifies the format of the records on the reference source.