aws-cdk-lib.aws_kinesisanalytics.CfnApplication.InputProperty

interface InputProperty

LanguageType name
.NETAmazon.CDK.AWS.KinesisAnalytics.CfnApplication.InputProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskinesisanalytics#CfnApplication_InputProperty
Javasoftware.amazon.awscdk.services.kinesisanalytics.CfnApplication.InputProperty
Pythonaws_cdk.aws_kinesisanalytics.CfnApplication.InputProperty
TypeScript 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

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.
namePrefixstringName 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 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.
kinesisStreamsInput?IResolvable | KinesisStreamsInputPropertyIf 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 | 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

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 | InputParallelismProperty (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 | 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 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 | KinesisStreamsInputProperty (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.