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