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