interface CfnApplicationReferenceDataSourceProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.KinesisAnalytics.CfnApplicationReferenceDataSourceProps |
Java | software.amazon.awscdk.services.kinesisanalytics.CfnApplicationReferenceDataSourceProps |
Python | aws_cdk.aws_kinesisanalytics.CfnApplicationReferenceDataSourceProps |
TypeScript | @aws-cdk/aws-kinesisanalytics » 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 * as kinesisanalytics from '@aws-cdk/aws-kinesisanalytics';
const cfnApplicationReferenceDataSourceProps: kinesisanalytics.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',
referenceRoleArn: 'referenceRoleArn',
},
tableName: 'tableName',
},
};
Properties
Name | Type | Description |
---|---|---|
application | string | Name of an existing application. |
reference | IResolvable | Reference | The reference data source can be an object in your Amazon S3 bucket. |
applicationName
Type:
string
Name of an existing application.
referenceDataSource
Type:
IResolvable
|
Reference
The reference data source can be an object in your Amazon S3 bucket.
Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.