interface InputProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.KinesisAnalytics.CfnApplication.InputProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awskinesisanalytics#CfnApplication_InputProperty |
![]() | software.amazon.awscdk.services.kinesisanalytics.CfnApplication.InputProperty |
![]() | aws_cdk.aws_kinesisanalytics.CfnApplication.InputProperty |
![]() | aws-cdk-lib » aws_kinesisanalytics » CfnApplication » InputProperty |
When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.
For more information, see Configuring Application Input .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisanalytics as kinesisanalytics } from 'aws-cdk-lib';
const inputProperty: kinesisanalytics.CfnApplication.InputProperty = {
inputSchema: {
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',
},
namePrefix: 'namePrefix',
// the properties below are optional
inputParallelism: {
count: 123,
},
inputProcessingConfiguration: {
inputLambdaProcessor: {
resourceArn: 'resourceArn',
roleArn: 'roleArn',
},
},
kinesisFirehoseInput: {
resourceArn: 'resourceArn',
roleArn: 'roleArn',
},
kinesisStreamsInput: {
resourceArn: 'resourceArn',
roleArn: 'roleArn',
},
};
Properties
Name | Type | Description |
---|---|---|
input | IResolvable | Input | Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. |
name | string | Name prefix to use when creating an in-application stream. |
input | IResolvable | Input | Describes the number of in-application streams to create. |
input | IResolvable | Input | The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor . |
kinesis | IResolvable | Kinesis | If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. |
kinesis | IResolvable | Kinesis | If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. |
inputSchema
Type:
IResolvable
|
Input
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
Also used to describe the format of the reference data source.
namePrefix
Type:
string
Name prefix to use when creating an in-application stream.
Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism
count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.
inputParallelism?
Type:
IResolvable
|
Input
(optional)
Describes the number of in-application streams to create.
Data from your source is routed to these in-application input streams.
See Configuring Application Input .
inputProcessingConfiguration?
Type:
IResolvable
|
Input
(optional)
The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor .
kinesisFirehoseInput?
Type:
IResolvable
|
Kinesis
(optional)
If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
Note: Either KinesisStreamsInput
or KinesisFirehoseInput
is required.
kinesisStreamsInput?
Type:
IResolvable
|
Kinesis
(optional)
If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
Note: Either KinesisStreamsInput
or KinesisFirehoseInput
is required.