Interface CfnApplicationReferenceDataSourcePropsMixin.IReferenceDataSourceProperty

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.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.KinesisAnalyticsV2

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnApplicationReferenceDataSourcePropsMixin.IReferenceDataSourceProperty

Syntax (vb)

Public Interface CfnApplicationReferenceDataSourcePropsMixin.IReferenceDataSourceProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.KinesisAnalyticsV2;

             var referenceDataSourceProperty = new ReferenceDataSourceProperty {
                 ReferenceSchema = new ReferenceSchemaProperty {
                     RecordColumns = new [] { new RecordColumnProperty {
                         Mapping = "mapping",
                         Name = "name",
                         SqlType = "sqlType"
                     } },
                     RecordEncoding = "recordEncoding",
                     RecordFormat = new RecordFormatProperty {
                         MappingParameters = new MappingParametersProperty {
                             CsvMappingParameters = new CSVMappingParametersProperty {
                                 RecordColumnDelimiter = "recordColumnDelimiter",
                                 RecordRowDelimiter = "recordRowDelimiter"
                             },
                             JsonMappingParameters = new JSONMappingParametersProperty {
                                 RecordRowPath = "recordRowPath"
                             }
                         },
                         RecordFormatType = "recordFormatType"
                     }
                 },
                 S3ReferenceDataSource = new S3ReferenceDataSourceProperty {
                     BucketArn = "bucketArn",
                     FileKey = "fileKey"
                 },
                 TableName = "tableName"
             };

Synopsis

Properties

ReferenceSchema	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	Identifies the S3 bucket and object that contains the reference data.
TableName	The name of the in-application table to create.

Properties

ReferenceSchema

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.

object? ReferenceSchema { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource-referenceschema

Type union: either IResolvable or CfnApplicationReferenceDataSourcePropsMixin.IReferenceSchemaProperty

S3ReferenceDataSource

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

object? S3ReferenceDataSource { get; }

Property Value

object

Remarks

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.

Type union: either IResolvable or CfnApplicationReferenceDataSourcePropsMixin.IS3ReferenceDataSourceProperty

TableName

The name of the in-application table to create.

string? TableName { get; }

Property Value

string