« blib/lib/Paws/KinesisAnalyticsV2/GlueDataCatalogConfigurationUpdate.pm
↑ Summary
blib/lib/Paws/KinesisAnalyticsV2/InputDescription.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KinesisAnalyticsV2::Input; | ||
| 3 | use Moose; | ||
| 4 | has InputParallelism => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::InputParallelism'); | ||
| 5 | has InputProcessingConfiguration => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::InputProcessingConfiguration'); | ||
| 6 | has InputSchema => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::SourceSchema', required => 1); | ||
| 7 | has KinesisFirehoseInput => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::KinesisFirehoseInput'); | ||
| 8 | has KinesisStreamsInput => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::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::KinesisAnalyticsV2::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::KinesisAnalyticsV2::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::KinesisAnalyticsV2::Input object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->InputParallelism | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | When you configure the application input for a SQL-based Kinesis Data | ||
| 42 | Analytics application, you specify the streaming source, the | ||
| 43 | in-application stream name that is created, and the mapping between the | ||
| 44 | two. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 InputParallelism => L<Paws::KinesisAnalyticsV2::InputParallelism> | ||
| 50 | |||
| 51 | Describes the number of in-application streams to create. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 InputProcessingConfiguration => L<Paws::KinesisAnalyticsV2::InputProcessingConfiguration> | ||
| 55 | |||
| 56 | The InputProcessingConfiguration for the input. An input processor | ||
| 57 | transforms records as they are received from the stream, before the | ||
| 58 | application's SQL code executes. Currently, the only input processing | ||
| 59 | configuration available is InputLambdaProcessor. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> InputSchema => L<Paws::KinesisAnalyticsV2::SourceSchema> | ||
| 63 | |||
| 64 | Describes the format of the data in the streaming source, and how each | ||
| 65 | data element maps to corresponding columns in the in-application stream | ||
| 66 | that is being created. | ||
| 67 | |||
| 68 | Also used to describe the format of the reference data source. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 KinesisFirehoseInput => L<Paws::KinesisAnalyticsV2::KinesisFirehoseInput> | ||
| 72 | |||
| 73 | If the streaming source is an Amazon Kinesis Data Firehose delivery | ||
| 74 | stream, identifies the delivery stream's ARN. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 KinesisStreamsInput => L<Paws::KinesisAnalyticsV2::KinesisStreamsInput> | ||
| 78 | |||
| 79 | If the streaming source is an Amazon Kinesis data stream, identifies | ||
| 80 | the stream's Amazon Resource Name (ARN). | ||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> NamePrefix => Str | ||
| 84 | |||
| 85 | The name prefix to use when creating an in-application stream. Suppose | ||
| 86 | that you specify a prefix "C<MyInApplicationStream>." Kinesis Data | ||
| 87 | Analytics then creates one or more (as per the C<InputParallelism> | ||
| 88 | count you specified) in-application streams with the names | ||
| 89 | "C<MyInApplicationStream_001>," "C<MyInApplicationStream_002>," and so | ||
| 90 | on. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, describing an object used in L<Paws::KinesisAnalyticsV2> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |