« blib/lib/Paws/KinesisAnalytics/RecordFormat.pm
↑ Summary
blib/lib/Paws/KinesisAnalytics/ReferenceDataSourceDescription.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KinesisAnalytics::ReferenceDataSource; | ||
| 3 | use Moose; | ||
| 4 | has ReferenceSchema => (is => 'ro', isa => 'Paws::KinesisAnalytics::SourceSchema', required => 1); | ||
| 5 | has S3ReferenceDataSource => (is => 'ro', isa => 'Paws::KinesisAnalytics::S3ReferenceDataSource'); | ||
| 6 | has TableName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::KinesisAnalytics::ReferenceDataSource | ||
| 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::ReferenceDataSource object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { ReferenceSchema => $value, ..., TableName => $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::ReferenceDataSource object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->ReferenceSchema | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Describes the reference data source by providing the source information | ||
| 39 | (S3 bucket name and object key name), the resulting in-application | ||
| 40 | table name that is created, and the necessary schema to map the data | ||
| 41 | elements in the Amazon S3 object to the in-application table. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> ReferenceSchema => L<Paws::KinesisAnalytics::SourceSchema> | ||
| 47 | |||
| 48 | Describes the format of the data in the streaming source, and how each | ||
| 49 | data element maps to corresponding columns created in the | ||
| 50 | in-application stream. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 S3ReferenceDataSource => L<Paws::KinesisAnalytics::S3ReferenceDataSource> | ||
| 54 | |||
| 55 | Identifies the S3 bucket and object that contains the reference data. | ||
| 56 | Also identifies the IAM role Amazon Kinesis Analytics can assume to | ||
| 57 | read this object on your behalf. An Amazon Kinesis Analytics | ||
| 58 | application loads reference data only once. If the data changes, you | ||
| 59 | call the C<UpdateApplication> operation to trigger reloading of data | ||
| 60 | into your application. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> TableName => Str | ||
| 64 | |||
| 65 | Name of the in-application table to create. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head1 SEE ALSO | ||
| 70 | |||
| 71 | This class forms part of L<Paws>, describing an object used in L<Paws::KinesisAnalytics> | ||
| 72 | |||
| 73 | =head1 BUGS and CONTRIBUTIONS | ||
| 74 | |||
| 75 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 76 | |||
| 77 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 78 | |||
| 79 | =cut | ||
| 80 |