aws-cdk-lib.aws_kinesisanalytics.CfnApplicationV2.InputProperty

interface InputProperty

LanguageType name
.NETAmazon.CDK.AWS.KinesisAnalytics.CfnApplicationV2.InputProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskinesisanalytics#CfnApplicationV2_InputProperty
Javasoftware.amazon.awscdk.services.kinesisanalytics.CfnApplicationV2.InputProperty
Pythonaws_cdk.aws_kinesisanalytics.CfnApplicationV2.InputProperty
TypeScript aws-cdk-lib » aws_kinesisanalytics » CfnApplicationV2 » InputProperty

When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.

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.CfnApplicationV2.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',
    },
  },
  kinesisFirehoseInput: {
    resourceArn: 'resourceArn',
  },
  kinesisStreamsInput: {
    resourceArn: 'resourceArn',
  },
};

Properties

NameTypeDescription
inputSchemaIResolvable | InputSchemaPropertyDescribes 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.
namePrefixstringThe name prefix to use when creating an in-application stream.
inputParallelism?IResolvable | InputParallelismPropertyDescribes the number of in-application streams to create.
inputProcessingConfiguration?IResolvable | InputProcessingConfigurationPropertyThe 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?IResolvable | KinesisFirehoseInputPropertyIf the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.
kinesisStreamsInput?IResolvable | KinesisStreamsInputPropertyIf the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).

inputSchema

Type: IResolvable | InputSchemaProperty

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

The name prefix to use when creating an in-application stream.

Suppose that you specify a prefix " MyInApplicationStream ." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names " MyInApplicationStream_001 ," " MyInApplicationStream_002 ," and so on.


inputParallelism?

Type: IResolvable | InputParallelismProperty (optional)

Describes the number of in-application streams to create.


inputProcessingConfiguration?

Type: IResolvable | InputProcessingConfigurationProperty (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 | KinesisFirehoseInputProperty (optional)

If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.


kinesisStreamsInput?

Type: IResolvable | KinesisStreamsInputProperty (optional)

If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).