libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.KinesisAnalytics.Types.Input

Description

 
Synopsis

Documentation

data Input Source #

When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see Configuring Application Input.

See: newInput smart constructor.

Constructors

Input' 

Fields

  • inputParallelism :: Maybe InputParallelism

    Describes the number of in-application streams to create.

    Data from your source is routed to these in-application input streams.

    (see Configuring Application Input.

  • inputProcessingConfiguration :: Maybe InputProcessingConfiguration

    The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.

  • kinesisStreamsInput :: Maybe KinesisStreamsInput

    If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

    Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

  • kinesisFirehoseInput :: Maybe KinesisFirehoseInput

    If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

    Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

  • namePrefix :: Text

    Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.

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

    Also used to describe the format of the reference data source.

Instances

Instances details
Eq Input Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.Input

Methods

(==) :: Input -> Input -> Bool #

(/=) :: Input -> Input -> Bool #

Read Input Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.Input

Show Input Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.Input

Methods

showsPrec :: Int -> Input -> ShowS #

show :: Input -> String #

showList :: [Input] -> ShowS #

Generic Input Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.Input

Associated Types

type Rep Input :: Type -> Type #

Methods

from :: Input -> Rep Input x #

to :: Rep Input x -> Input #

NFData Input Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.Input

Methods

rnf :: Input -> () #

Hashable Input Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.Input

Methods

hashWithSalt :: Int -> Input -> Int #

hash :: Input -> Int #

ToJSON Input Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.Input

type Rep Input Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.Types.Input

type Rep Input = D1 ('MetaData "Input" "Amazonka.KinesisAnalytics.Types.Input" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "Input'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "inputParallelism") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputParallelism)) :*: (S1 ('MetaSel ('Just "inputProcessingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputProcessingConfiguration)) :*: S1 ('MetaSel ('Just "kinesisStreamsInput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisStreamsInput)))) :*: (S1 ('MetaSel ('Just "kinesisFirehoseInput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisFirehoseInput)) :*: (S1 ('MetaSel ('Just "namePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "inputSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SourceSchema)))))

newInput Source #

Create a value of Input 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:inputParallelism:Input', input_inputParallelism - Describes the number of in-application streams to create.

Data from your source is routed to these in-application input streams.

(see Configuring Application Input.

$sel:inputProcessingConfiguration:Input', input_inputProcessingConfiguration - The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.

$sel:kinesisStreamsInput:Input', input_kinesisStreamsInput - If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

$sel:kinesisFirehoseInput:Input', input_kinesisFirehoseInput - If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

$sel:namePrefix:Input', input_namePrefix - Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.

$sel:inputSchema:Input', input_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.

Also used to describe the format of the reference data source.

input_inputParallelism :: Lens' Input (Maybe InputParallelism) Source #

Describes the number of in-application streams to create.

Data from your source is routed to these in-application input streams.

(see Configuring Application Input.

input_inputProcessingConfiguration :: Lens' Input (Maybe InputProcessingConfiguration) Source #

The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.

input_kinesisStreamsInput :: Lens' Input (Maybe KinesisStreamsInput) Source #

If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

input_kinesisFirehoseInput :: Lens' Input (Maybe KinesisFirehoseInput) Source #

If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

input_namePrefix :: Lens' Input Text Source #

Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.

input_inputSchema :: Lens' Input 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.

Also used to describe the format of the reference data source.