Amazonka.KinesisAnalyticsV2.Types.InputDescription

Documentation

data InputDescription

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

See: newInputDescription smart constructor.

Constructors

InputDescription'

Fields

• inAppStreamNames :: Maybe [Text]

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

• inputId :: Maybe Text

  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.

• inputParallelism :: Maybe InputParallelism

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

• inputProcessingConfigurationDescription :: Maybe InputProcessingConfigurationDescription

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

• inputSchema :: Maybe 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.

• inputStartingPositionConfiguration :: Maybe InputStartingPositionConfiguration

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

• kinesisFirehoseInputDescription :: Maybe KinesisFirehoseInputDescription

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

• kinesisStreamsInputDescription :: Maybe KinesisStreamsInputDescription

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

• namePrefix :: Maybe Text

  The in-application name prefix.

Instances

FromJSON InputDescription

Defined in Amazonka.KinesisAnalyticsV2.Types.InputDescription

Methods

parseJSON :: Value -> Parser InputDescription

parseJSONList :: Value -> Parser [InputDescription]

Generic InputDescription

Defined in Amazonka.KinesisAnalyticsV2.Types.InputDescription

Associated Types

type Rep InputDescription :: Type -> Type

Methods

from :: InputDescription -> Rep InputDescription x

to :: Rep InputDescription x -> InputDescription

Read InputDescription

Defined in Amazonka.KinesisAnalyticsV2.Types.InputDescription

Methods

readsPrec :: Int -> ReadS InputDescription

readList :: ReadS [InputDescription]

readPrec :: ReadPrec InputDescription

readListPrec :: ReadPrec [InputDescription]

Show InputDescription

Defined in Amazonka.KinesisAnalyticsV2.Types.InputDescription

Methods

showsPrec :: Int -> InputDescription -> ShowS

show :: InputDescription -> String

showList :: [InputDescription] -> ShowS

NFData InputDescription

Defined in Amazonka.KinesisAnalyticsV2.Types.InputDescription

Methods

rnf :: InputDescription -> ()

Eq InputDescription

Defined in Amazonka.KinesisAnalyticsV2.Types.InputDescription

Methods

(==) :: InputDescription -> InputDescription -> Bool

(/=) :: InputDescription -> InputDescription -> Bool

Hashable InputDescription

Defined in Amazonka.KinesisAnalyticsV2.Types.InputDescription

Methods

hashWithSalt :: Int -> InputDescription -> Int

hash :: InputDescription -> Int

type Rep InputDescription

Defined in Amazonka.KinesisAnalyticsV2.Types.InputDescription

type Rep InputDescription = D1 ('MetaData "InputDescription" "Amazonka.KinesisAnalyticsV2.Types.InputDescription" "amazonka-kinesisanalyticsv2-2.0-EuRTRS4ROZrHrkll3mMtCB" 'False) (C1 ('MetaCons "InputDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "inAppStreamNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "inputId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inputParallelism") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputParallelism)) :*: S1 ('MetaSel ('Just "inputProcessingConfigurationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputProcessingConfigurationDescription)))) :*: ((S1 ('MetaSel ('Just "inputSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceSchema)) :*: S1 ('MetaSel ('Just "inputStartingPositionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputStartingPositionConfiguration))) :*: (S1 ('MetaSel ('Just "kinesisFirehoseInputDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisFirehoseInputDescription)) :*: (S1 ('MetaSel ('Just "kinesisStreamsInputDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisStreamsInputDescription)) :*: S1 ('MetaSel ('Just "namePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newInputDescription :: InputDescription

Create a value of InputDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:inAppStreamNames:InputDescription', inputDescription_inAppStreamNames - Returns the in-application stream names that are mapped to the stream source.

$sel:inputId:InputDescription', inputDescription_inputId - 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.

$sel:inputParallelism:InputDescription', inputDescription_inputParallelism - Describes the configured parallelism (number of in-application streams mapped to the streaming source).

$sel:inputProcessingConfigurationDescription:InputDescription', inputDescription_inputProcessingConfigurationDescription - The description of the preprocessor that executes on records in this input before the application's code is run.

$sel:inputSchema:InputDescription', inputDescription_inputSchema - 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.

$sel:inputStartingPositionConfiguration:InputDescription', inputDescription_inputStartingPositionConfiguration - The point at which the application is configured to read from the input stream.

$sel:kinesisFirehoseInputDescription:InputDescription', inputDescription_kinesisFirehoseInputDescription - If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

$sel:kinesisStreamsInputDescription:InputDescription', inputDescription_kinesisStreamsInputDescription - If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

$sel:namePrefix:InputDescription', inputDescription_namePrefix - The in-application name prefix.

inputDescription_inAppStreamNames :: Lens' InputDescription (Maybe [Text])

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

inputDescription_inputId :: Lens' InputDescription (Maybe Text)

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.

inputDescription_inputParallelism :: Lens' InputDescription (Maybe InputParallelism)

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

inputDescription_inputProcessingConfigurationDescription :: Lens' InputDescription (Maybe InputProcessingConfigurationDescription)

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

inputDescription_inputSchema :: Lens' InputDescription (Maybe 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.

inputDescription_inputStartingPositionConfiguration :: Lens' InputDescription (Maybe InputStartingPositionConfiguration)

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

inputDescription_kinesisFirehoseInputDescription :: Lens' InputDescription (Maybe KinesisFirehoseInputDescription)

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

inputDescription_kinesisStreamsInputDescription :: Lens' InputDescription (Maybe KinesisStreamsInputDescription)

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

inputDescription_namePrefix :: Lens' InputDescription (Maybe Text)

The in-application name prefix.