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

Inherits:

Struct

• Object
• Struct
• Aws::KinesisAnalyticsV2::Types::InputDescription

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #in_app_stream_names ⇒ Array<String>

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

• #input_id ⇒ String

  The input ID that is associated with the application input.

• #input_parallelism ⇒ Types::InputParallelism

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

• #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.

• #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.

• #input_starting_position_configuration ⇒ Types::InputStartingPositionConfiguration

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

• #kinesis_firehose_input_description ⇒ Types::KinesisFirehoseInputDescription

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

• #kinesis_streams_input_description ⇒ Types::KinesisStreamsInputDescription

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

• #name_prefix ⇒ String

  The in-application name prefix.

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

# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2904

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

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)

# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2904

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:

• (Types::InputParallelism)

# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2904

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:

• (Types::InputProcessingConfigurationDescription)

# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2904

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:

• (Types::SourceSchema)

# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2904

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

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

Returns:

• (Types::InputStartingPositionConfiguration)

# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2904

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 a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

Returns:

• (Types::KinesisFirehoseInputDescription)

# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2904

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 a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

Returns:

• (Types::KinesisStreamsInputDescription)

# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2904

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

The in-application name prefix.

Returns:

• (String)

# File 'gems/aws-sdk-kinesisanalyticsv2/lib/aws-sdk-kinesisanalyticsv2/types.rb', line 2904

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