Skip to content

InputDescription

Source code in docs_src/capo_kinesis_analytics/types/input_description.py
class InputDescription(TypedDict, closed=True):
    input_id: NotRequired["capo_kinesis_analytics.types.id.Id"]
    """<p>Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application. </p>"""
    name_prefix: NotRequired[
        "capo_kinesis_analytics.types.in_app_stream_name.InAppStreamName"
    ]
    """<p>In-application name prefix.</p>"""
    in_app_stream_names: NotRequired[
        "capo_kinesis_analytics.types.in_app_stream_names.InAppStreamNames"
    ]
    """<p>Returns the in-application stream names that are mapped to the stream source.</p>"""
    input_processing_configuration_description: NotRequired[
        "capo_kinesis_analytics.types.input_processing_configuration_description.InputProcessingConfigurationDescription"
    ]
    """<p>The description of the preprocessor that executes on records in this input before the application's code is run.</p>"""
    kinesis_streams_input_description: NotRequired[
        "capo_kinesis_analytics.types.kinesis_streams_input_description.KinesisStreamsInputDescription"
    ]
    """<p>If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"""
    kinesis_firehose_input_description: NotRequired[
        "capo_kinesis_analytics.types.kinesis_firehose_input_description.KinesisFirehoseInputDescription"
    ]
    """<p>If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"""
    input_schema: NotRequired["capo_kinesis_analytics.types.source_schema.SourceSchema"]
    """<p>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. </p>"""
    input_parallelism: NotRequired[
        "capo_kinesis_analytics.types.input_parallelism.InputParallelism"
    ]
    """<p>Describes the configured parallelism (number of in-application streams mapped to the streaming source).</p>"""
    input_starting_position_configuration: NotRequired[
        "capo_kinesis_analytics.types.input_starting_position_configuration.InputStartingPositionConfiguration"
    ]
    """<p>Point at which the application is configured to read from the input stream.</p>"""

in_app_stream_names instance-attribute

in_app_stream_names: NotRequired[InAppStreamNames]

Returns the in-application stream names that are mapped to the stream source.

input_id instance-attribute

input_id: NotRequired[Id]

Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.

input_parallelism instance-attribute

input_parallelism: NotRequired[InputParallelism]

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

input_processing_configuration_description instance-attribute

input_processing_configuration_description: NotRequired[
    InputProcessingConfigurationDescription
]

The description of the preprocessor that executes on records in this input before the application's code is run.

input_schema instance-attribute

input_schema: NotRequired[SourceSchema]

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.

input_starting_position_configuration instance-attribute

input_starting_position_configuration: NotRequired[InputStartingPositionConfiguration]

Point at which the application is configured to read from the input stream.

kinesis_firehose_input_description instance-attribute

kinesis_firehose_input_description: NotRequired[KinesisFirehoseInputDescription]

If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

kinesis_streams_input_description instance-attribute

kinesis_streams_input_description: NotRequired[KinesisStreamsInputDescription]

If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

name_prefix instance-attribute

name_prefix: NotRequired[InAppStreamName]

In-application name prefix.