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

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

Overview

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

[1]: docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#in_app_stream_names ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/aws-sdk-kinesisanalytics/types.rb', line 1097

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)
  SENSITIVE = []
  include Aws::Structure
end

#input_id ⇒ String

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) 


1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/aws-sdk-kinesisanalytics/types.rb', line 1097

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)
  SENSITIVE = []
  include Aws::Structure
end

#input_parallelism ⇒ Types::InputParallelism

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

Returns:



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/aws-sdk-kinesisanalytics/types.rb', line 1097

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)
  SENSITIVE = []
  include Aws::Structure
end

#input_processing_configuration_description ⇒ Types::InputProcessingConfigurationDescription

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

Returns:



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/aws-sdk-kinesisanalytics/types.rb', line 1097

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)
  SENSITIVE = []
  include Aws::Structure
end

#input_schema ⇒ Types::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:



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/aws-sdk-kinesisanalytics/types.rb', line 1097

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)
  SENSITIVE = []
  include Aws::Structure
end

#input_starting_position_configuration ⇒ Types::InputStartingPositionConfiguration

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

Returns:



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/aws-sdk-kinesisanalytics/types.rb', line 1097

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)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_firehose_input_description ⇒ Types::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.

Returns:



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/aws-sdk-kinesisanalytics/types.rb', line 1097

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)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_streams_input_description ⇒ Types::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.

Returns:



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/aws-sdk-kinesisanalytics/types.rb', line 1097

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)
  SENSITIVE = []
  include Aws::Structure
end

#name_prefix ⇒ String

In-application name prefix.

Returns:

  • (String) 


1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/aws-sdk-kinesisanalytics/types.rb', line 1097

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)
  SENSITIVE = []
  include Aws::Structure
end