aws-cdk-lib.aws_kinesisanalyticsv2.CfnApplicationReferenceDataSourceProps

interface CfnApplicationReferenceDataSourceProps

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

Properties for defining a CfnApplicationReferenceDataSource.

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 cfnApplicationReferenceDataSourceProps: kinesisanalyticsv2.CfnApplicationReferenceDataSourceProps = {
  applicationName: 'applicationName',
  referenceDataSource: {
    referenceSchema: {
      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',
    },

    // the properties below are optional
    s3ReferenceDataSource: {
      bucketArn: 'bucketArn',
      fileKey: 'fileKey',
    },
    tableName: 'tableName',
  },
};

Properties

NameTypeDescription
applicationNamestringThe name of the application.
referenceDataSourceIResolvable | ReferenceDataSourcePropertyFor 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.

applicationName

Type: string

The name of the application.


referenceDataSource

Type: IResolvable | 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.