You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::KinesisAnalyticsV2::Types::InputDescription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb

Overview

Describes the application input configuration for an SQL-based Amazon Kinesis Data Analytics application.

Instance Attribute Summary collapse

Instance Attribute Details

#in_app_stream_namesArray<String>

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

Returns:

  • (Array<String>)


2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2561

class InputDescription < Struct.new(
  :input_id,
  :name_prefix,
  :in_app_stream_names,
  :input_processing_configuration_description,
  :kinesis_streams_input_description,
  :kinesis_firehose_input_description,
  :input_schema,
  :input_parallelism,
  :input_starting_position_configuration)
  include Aws::Structure
end

#input_idString

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

Returns:

  • (String)


2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2561

class InputDescription < Struct.new(
  :input_id,
  :name_prefix,
  :in_app_stream_names,
  :input_processing_configuration_description,
  :kinesis_streams_input_description,
  :kinesis_firehose_input_description,
  :input_schema,
  :input_parallelism,
  :input_starting_position_configuration)
  include Aws::Structure
end

#input_parallelismTypes::InputParallelism

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



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2561

class InputDescription < Struct.new(
  :input_id,
  :name_prefix,
  :in_app_stream_names,
  :input_processing_configuration_description,
  :kinesis_streams_input_description,
  :kinesis_firehose_input_description,
  :input_schema,
  :input_parallelism,
  :input_starting_position_configuration)
  include Aws::Structure
end

#input_processing_configuration_descriptionTypes::InputProcessingConfigurationDescription

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



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2561

class InputDescription < Struct.new(
  :input_id,
  :name_prefix,
  :in_app_stream_names,
  :input_processing_configuration_description,
  :kinesis_streams_input_description,
  :kinesis_firehose_input_description,
  :input_schema,
  :input_parallelism,
  :input_starting_position_configuration)
  include Aws::Structure
end

#input_schemaTypes::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.

Returns:



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2561

class InputDescription < Struct.new(
  :input_id,
  :name_prefix,
  :in_app_stream_names,
  :input_processing_configuration_description,
  :kinesis_streams_input_description,
  :kinesis_firehose_input_description,
  :input_schema,
  :input_parallelism,
  :input_starting_position_configuration)
  include Aws::Structure
end

#input_starting_position_configurationTypes::InputStartingPositionConfiguration

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



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2561

class InputDescription < Struct.new(
  :input_id,
  :name_prefix,
  :in_app_stream_names,
  :input_processing_configuration_description,
  :kinesis_streams_input_description,
  :kinesis_firehose_input_description,
  :input_schema,
  :input_parallelism,
  :input_starting_position_configuration)
  include Aws::Structure
end

#kinesis_firehose_input_descriptionTypes::KinesisFirehoseInputDescription

If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2561

class InputDescription < Struct.new(
  :input_id,
  :name_prefix,
  :in_app_stream_names,
  :input_processing_configuration_description,
  :kinesis_streams_input_description,
  :kinesis_firehose_input_description,
  :input_schema,
  :input_parallelism,
  :input_starting_position_configuration)
  include Aws::Structure
end

#kinesis_streams_input_descriptionTypes::KinesisStreamsInputDescription

If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2561

class InputDescription < Struct.new(
  :input_id,
  :name_prefix,
  :in_app_stream_names,
  :input_processing_configuration_description,
  :kinesis_streams_input_description,
  :kinesis_firehose_input_description,
  :input_schema,
  :input_parallelism,
  :input_starting_position_configuration)
  include Aws::Structure
end

#name_prefixString

The in-application name prefix.

Returns:

  • (String)


2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2561

class InputDescription < Struct.new(
  :input_id,
  :name_prefix,
  :in_app_stream_names,
  :input_processing_configuration_description,
  :kinesis_streams_input_description,
  :kinesis_firehose_input_description,
  :input_schema,
  :input_parallelism,
  :input_starting_position_configuration)
  include Aws::Structure
end