Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KinesisAnalytics.Types.InputDescription

Description

Synopsis

Documentation

data InputDescription Source #

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

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
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.
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
Point at which the application is configured to read from the input stream.
kinesisFirehoseInputDescription :: Maybe 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.
kinesisStreamsInputDescription :: Maybe 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.
namePrefix :: Maybe Text
In-application name prefix.

Instances

Instances details

FromJSON InputDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.InputDescription Methods parseJSON :: Value -> Parser InputDescription # parseJSONList :: Value -> Parser [InputDescription] #
Generic InputDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.InputDescription Associated Types type Rep InputDescription :: Type -> Type # Methods from :: InputDescription -> Rep InputDescription x # to :: Rep InputDescription x -> InputDescription #
Read InputDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.InputDescription Methods readsPrec :: Int -> ReadS InputDescription # readList :: ReadS [InputDescription] # readPrec :: ReadPrec InputDescription # readListPrec :: ReadPrec [InputDescription] #
Show InputDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.InputDescription Methods showsPrec :: Int -> InputDescription -> ShowS # show :: InputDescription -> String # showList :: [InputDescription] -> ShowS #
NFData InputDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.InputDescription Methods rnf :: InputDescription -> () #
Eq InputDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.InputDescription Methods (==) :: InputDescription -> InputDescription -> Bool # (/=) :: InputDescription -> InputDescription -> Bool #
Hashable InputDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.InputDescription Methods hashWithSalt :: Int -> InputDescription -> Int # hash :: InputDescription -> Int #
type Rep InputDescription Source #
Instance details Defined in Amazonka.KinesisAnalytics.Types.InputDescription type Rep InputDescription = D1 ('MetaData "InputDescription" "Amazonka.KinesisAnalytics.Types.InputDescription" "amazonka-kinesis-analytics-2.0-7I8X2DEyFUlG6TCxCRLiwg" '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 Source #

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

$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 - Point at which the application is configured to read from the input stream.

$sel:kinesisFirehoseInputDescription:InputDescription', inputDescription_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.

$sel:kinesisStreamsInputDescription:InputDescription', inputDescription_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.

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

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

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

inputDescription_inputId :: Lens' InputDescription (Maybe Text) Source #

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.

inputDescription_inputParallelism :: Lens' InputDescription (Maybe InputParallelism) Source #

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

inputDescription_inputProcessingConfigurationDescription :: Lens' InputDescription (Maybe InputProcessingConfigurationDescription) Source #

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

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

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

inputDescription_kinesisFirehoseInputDescription :: Lens' InputDescription (Maybe KinesisFirehoseInputDescription) Source #

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.

inputDescription_kinesisStreamsInputDescription :: Lens' InputDescription (Maybe KinesisStreamsInputDescription) Source #

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.

inputDescription_namePrefix :: Lens' InputDescription (Maybe Text) Source #

In-application name prefix.