Class CfnApplicationReferenceDataSourceV2.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.

Inheritance

object

CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty

Implements

CfnApplicationReferenceDataSourceV2.IReferenceDataSourceProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.KinesisAnalytics

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty : CfnApplicationReferenceDataSourceV2.IReferenceDataSourceProperty

Syntax (vb)

Public Class CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty Implements CfnApplicationReferenceDataSourceV2.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.AWS.KinesisAnalytics;

             var referenceDataSourceProperty = new ReferenceDataSourceProperty {
                 ReferenceSchema = 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"
                 },

                 // the properties below are optional
                 S3ReferenceDataSource = new S3ReferenceDataSourceProperty {
                     BucketArn = "bucketArn",
                     FileKey = "fileKey"
                 },
                 TableName = "tableName"
             };

Synopsis

Constructors

ReferenceDataSourceProperty()

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.

Constructors

ReferenceDataSourceProperty()

public ReferenceDataSourceProperty()

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.AWS.KinesisAnalytics;

             var referenceDataSourceProperty = new ReferenceDataSourceProperty {
                 ReferenceSchema = 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"
                 },

                 // the properties below are optional
                 S3ReferenceDataSource = new S3ReferenceDataSourceProperty {
                     BucketArn = "bucketArn",
                     FileKey = "fileKey"
                 },
                 TableName = "tableName"
             };

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.

public object ReferenceSchema { get; set; }

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 CfnApplicationReferenceDataSourceV2.IReferenceSchemaProperty

S3ReferenceDataSource

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

public object? S3ReferenceDataSource { get; set; }

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 CfnApplicationReferenceDataSourceV2.IS3ReferenceDataSourceProperty

TableName

The name of the in-application table to create.

public string? TableName { get; set; }