class CfnApplicationReferenceDataSourcePropsMixin
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.KinesisAnalytics.Mixins.CfnApplicationReferenceDataSourcePropsMixin |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskinesisanalytics/mixins#CfnApplicationReferenceDataSourcePropsMixin |
Java | software.amazon.awscdk.mixins.preview.services.kinesisanalytics.mixins.CfnApplicationReferenceDataSourcePropsMixin |
Python | aws_cdk.mixins_preview.aws_kinesisanalytics.mixins.CfnApplicationReferenceDataSourcePropsMixin |
TypeScript | @aws-cdk/mixins-preview » aws_kinesisanalytics » mixins » CfnApplicationReferenceDataSourcePropsMixin |
Implements
IMixin
Extends
Mixin
Adds a reference data source to an existing application.
Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.
For conceptual information, see Configuring Application Input . For the limits on data sources you can add to your application, see Limits .
This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as kinesisanalytics_mixins } from '@aws-cdk/mixins-preview/aws-kinesisanalytics';
const cfnApplicationReferenceDataSourcePropsMixin = new kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin({
applicationName: 'applicationName',
referenceDataSource: {
referenceSchema: {
recordColumns: [{
mapping: 'mapping',
name: 'name',
sqlType: 'sqlType',
}],
recordEncoding: 'recordEncoding',
recordFormat: {
mappingParameters: {
csvMappingParameters: {
recordColumnDelimiter: 'recordColumnDelimiter',
recordRowDelimiter: 'recordRowDelimiter',
},
jsonMappingParameters: {
recordRowPath: 'recordRowPath',
},
},
recordFormatType: 'recordFormatType',
},
},
s3ReferenceDataSource: {
bucketArn: 'bucketArn',
fileKey: 'fileKey',
referenceRoleArn: 'referenceRoleArn',
},
tableName: 'tableName',
},
}, /* all optional props */ {
strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});
Initializer
new CfnApplicationReferenceDataSourcePropsMixin(props: CfnApplicationReferenceDataSourceMixinProps, options?: CfnPropertyMixinOptions)
Parameters
- props
Cfn— L1 properties to apply.Application Reference Data Source Mixin Props - options
Cfn— Mixin options.Property Mixin Options
Create a mixin to apply properties to AWS::KinesisAnalytics::ApplicationReferenceDataSource.
Properties
| Name | Type | Description |
|---|---|---|
| props | Cfn | |
| strategy | Property | |
| static CFN_PROPERTY_KEYS | string[] |
props
Type:
Cfn
strategy
Type:
Property
static CFN_PROPERTY_KEYS
Type:
string[]
Methods
| Name | Description |
|---|---|
| apply | Apply the mixin properties to the construct. |
| supports(construct) | Check if this mixin supports the given construct. |
applyTo(construct)
public applyTo(construct: IConstruct): IConstruct
Parameters
- construct
IConstruct
Returns
Apply the mixin properties to the construct.
supports(construct)
public supports(construct: IConstruct): boolean
Parameters
- construct
IConstruct
Returns
boolean
Check if this mixin supports the given construct.

.NET
Go
Java
Python
TypeScript