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

Class: Aws::KinesisAnalytics::Types::InputDescription

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

Overview

Describes the application input configuration. For more information, see Configuring Application Input.

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>)


1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1417

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

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.

Returns:

  • (String)


1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1417

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).



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1417

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.



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1417

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:



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1417

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

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



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1417

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 an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1417

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 an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1417

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

In-application name prefix.

Returns:

  • (String)


1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/types.rb', line 1417

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