File Coverage

blib/lib/Paws/KinesisAnalytics/Input.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::KinesisAnalytics::Input;
2 1     1   347 use Moose;
  1         2  
  1         7  
3             has InputParallelism => (is => 'ro', isa => 'Paws::KinesisAnalytics::InputParallelism');
4             has InputProcessingConfiguration => (is => 'ro', isa => 'Paws::KinesisAnalytics::InputProcessingConfiguration');
5             has InputSchema => (is => 'ro', isa => 'Paws::KinesisAnalytics::SourceSchema', required => 1);
6             has KinesisFirehoseInput => (is => 'ro', isa => 'Paws::KinesisAnalytics::KinesisFirehoseInput');
7             has KinesisStreamsInput => (is => 'ro', isa => 'Paws::KinesisAnalytics::KinesisStreamsInput');
8             has NamePrefix => (is => 'ro', isa => 'Str', required => 1);
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::KinesisAnalytics::Input
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::KinesisAnalytics::Input object:
27              
28             $service_obj->Method(Att1 => { InputParallelism => $value, ..., NamePrefix => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::KinesisAnalytics::Input object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->InputParallelism
36              
37             =head1 DESCRIPTION
38              
39             When you configure the application input, you specify the streaming
40             source, the in-application stream name that is created, and the mapping
41             between the two. For more information, see Configuring Application
42             Input.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 InputParallelism => L<Paws::KinesisAnalytics::InputParallelism>
48              
49             Describes the number of in-application streams to create.
50              
51             Data from your source will be routed to these in-application input
52             streams.
53              
54             (see Configuring Application Input.
55              
56              
57             =head2 InputProcessingConfiguration => L<Paws::KinesisAnalytics::InputProcessingConfiguration>
58              
59             The InputProcessingConfiguration for the Input. An input processor
60             transforms records as they are received from the stream, before the
61             application's SQL code executes. Currently, the only input processing
62             configuration available is InputLambdaProcessor.
63              
64              
65             =head2 B<REQUIRED> InputSchema => L<Paws::KinesisAnalytics::SourceSchema>
66              
67             Describes the format of the data in the streaming source, and how each
68             data element maps to corresponding columns in the in-application stream
69             that is being created.
70              
71             Also used to describe the format of the reference data source.
72              
73              
74             =head2 KinesisFirehoseInput => L<Paws::KinesisAnalytics::KinesisFirehoseInput>
75              
76             If the streaming source is an Amazon Kinesis Firehose delivery stream,
77             identifies the Firehose delivery stream's ARN and an IAM role that
78             enables Amazon Kinesis Analytics to access the stream on your behalf.
79              
80             Note: Either C<KinesisStreamsInput> or C<KinesisFirehoseInput> is
81             required.
82              
83              
84             =head2 KinesisStreamsInput => L<Paws::KinesisAnalytics::KinesisStreamsInput>
85              
86             If the streaming source is an Amazon Kinesis stream, identifies the
87             stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon
88             Kinesis Analytics to access the stream on your behalf.
89              
90             Note: Either C<KinesisStreamsInput> or C<KinesisFirehoseInput> is
91             required.
92              
93              
94             =head2 B<REQUIRED> NamePrefix => Str
95              
96             Name prefix to use when creating in-application stream. Suppose you
97             specify a prefix "MyInApplicationStream". Amazon Kinesis Analytics will
98             then create one or more (as per the C<InputParallelism> count you
99             specified) in-application streams with names
100             "MyInApplicationStream_001", "MyInApplicationStream_002" and so on.
101              
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, describing an object used in L<Paws::KinesisAnalytics>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115